class ChannelsAPI

export declare class ChannelsAPI
addGroupDMRecipient
addMessageReaction
bulkDeleteMessages
createForumThread
createInvite
createMessage
createThread
createWebhook
crosspostMessage
delete
deleteAllMessageReactions
deleteAllMessageReactionsForEmoji
deleteMessage
deleteOwnMessageReaction
deletePermissionOverwrite
deleteUserMessageReaction
edit
editMessage
editPermissionOverwrite
followAnnouncements
get
getArchivedThreads
getInvites
getJoinedPrivateArchivedThreads
getMessage
getMessageReactions
getMessages
getPins
getWebhooks
pinMessage
removeGroupDMRecipient
sendSoundboardSound
showTyping
unpinMessage

Constructors

constructor(
rest: REST
)

Constructs a new instance of the ChannelsAPI class

addGroupDMRecipient(
channelId: Snowflake
userId: Snowflake
body: RESTPutAPIChannelRecipientJSONBody
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<void>

Adds a recipient to a group DM channel

See also: https://discord.com/developers/docs/resources/channel#group-dm-add-recipient

addMessageReaction(
channelId: Snowflake
messageId: Snowflake
emoji: string
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<void>

Adds a reaction to a message

Examples:
// Unicode.
await api.channels.addMessageReaction('1234567890', '1234567890', '👍');

// Custom emoji.
await api.channels.addMessageReaction('1234567890', '1234567890', 'emoji_name:1234567890');

See also: https://discord.com/developers/docs/resources/message#create-reaction

bulkDeleteMessages(
channelId: Snowflake
messageIds: Snowflake[]
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<void>

Bulk deletes messages

See also: https://discord.com/developers/docs/resources/message#bulk-delete-messages

createForumThread(
channelId: Snowflake
body: StartForumThreadOptions
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIThreadChannel<ThreadChannelType>>

Creates a new forum post

See also: https://discord.com/developers/docs/resources/channel#start-thread-in-forum-or-media-channel

createInvite(
channelId: Snowflake
body: RESTPostAPIChannelInviteJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIExtendedInvite>

Creates a new invite for a channel

See also: https://discord.com/developers/docs/resources/channel#create-channel-invite

createMessage(
channelId: Snowflake
body: CreateMessageOptions
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIMessage>

Sends a message in a channel

See also: https://discord.com/developers/docs/resources/message#create-message

createThread(
channelId: Snowflake
body: RESTPostAPIChannelThreadsJSONBody
messageId?: Snowflake
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<RESTPostAPIChannelThreadsResult>

Creates a new thread

See also: https://discord.com/developers/docs/resources/channel#start-thread-from-messagehttps://discord.com/developers/docs/resources/channel#start-thread-without-message

createWebhook(
channelId: Snowflake
body: RESTPostAPIChannelWebhookJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIWebhook>

Creates a new webhook

See also: https://discord.com/developers/docs/resources/webhook#create-webhook

crosspostMessage(
channelId: Snowflake
messageId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIMessage>

Crossposts a message

See also: https://discord.com/developers/docs/resources/message#crosspost-message

delete(
channelId: Snowflake
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIChannel>

Deletes a channel

See also: https://discord.com/developers/docs/resources/channel#deleteclose-channel

deleteAllMessageReactions(
channelId: Snowflake
messageId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<void>

Deletes all reactions for a message

See also: https://discord.com/developers/docs/resources/message#delete-all-reactions

deleteAllMessageReactionsForEmoji(
channelId: Snowflake
messageId: Snowflake
emoji: string
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<void>

Deletes all reactions of an emoji for a message

Examples:
// Unicode.
await api.channels.deleteAllMessageReactionsForEmoji('1234567890', '1234567890', '👍');

// Custom emoji.
await api.channels.deleteAllMessageReactionsForEmoji('1234567890', '1234567890', 'emoji_name:1234567890');

See also: https://discord.com/developers/docs/resources/message#delete-all-reactions-for-emoji

deleteMessage(
channelId: Snowflake
messageId: Snowflake
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<void>

Deletes a message

See also: https://discord.com/developers/docs/resources/message#delete-message

deleteOwnMessageReaction(
channelId: Snowflake
messageId: Snowflake
emoji: string
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<void>

Deletes a reaction for the current user

Examples:
// Unicode.
await api.channels.deleteOwnMessageReaction('1234567890', '1234567890', '👍');

// Custom emoji.
await api.channels.deleteOwnMessageReaction('1234567890', '1234567890', 'emoji_name:1234567890');

See also: https://discord.com/developers/docs/resources/message#delete-own-reaction

deletePermissionOverwrite(
channelId: Snowflake
overwriteId: Snowflake
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<void>

Deletes the permission overwrite for a user or role in a channel

See also: https://discord.com/developers/docs/resources/channel#delete-channel-permission

deleteUserMessageReaction(
channelId: Snowflake
messageId: Snowflake
emoji: string
userId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<void>

Deletes a reaction for a user

Examples:
// Unicode.
await api.channels.deleteUserMessageReaction('1234567890', '1234567890', '👍', '1234567890');

// Custom emoji.
await api.channels.deleteUserMessageReaction('1234567890', '1234567890', 'emoji_name:1234567890', '1234567890');

See also: https://discord.com/developers/docs/resources/message#delete-user-reaction

edit(
channelId: Snowflake
body: RESTPatchAPIChannelJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIChannel>

Edits a channel

See also: https://discord.com/developers/docs/resources/channel#modify-channel

editMessage(
channelId: Snowflake
messageId: Snowflake
body: EditMessageOptions
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIMessage>

Edits a message

See also: https://discord.com/developers/docs/resources/message#edit-message

editPermissionOverwrite(
channelId: Snowflake
overwriteId: Snowflake
body: RESTPutAPIChannelPermissionJSONBody
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<void>

Edits the permission overwrite for a user or role in a channel

See also: https://discord.com/developers/docs/resources/channel#edit-channel-permissions

followAnnouncements(
channelId: Snowflake
webhookChannelId: Snowflake
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<APIFollowedChannel>

Follows an announcement channel

See also: https://discord.com/developers/docs/resources/channel#follow-announcement-channel

get(
channelId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIChannel>

Fetches a channel

See also: https://discord.com/developers/docs/resources/channel#get-channel

getArchivedThreads(
channelId: Snowflake
archivedStatus: 'private' | 'public'
query?: RESTGetAPIChannelThreadsArchivedQuery
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIChannelUsersThreadsArchivedResult>

Fetches the archived threads of a channel

See also: https://discord.com/developers/docs/resources/channel#list-public-archived-threadshttps://discord.com/developers/docs/resources/channel#list-private-archived-threads

getInvites(
channelId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIChannelInvitesResult>

Fetches the invites of a channel

See also: https://discord.com/developers/docs/resources/channel#get-channel-invites

getJoinedPrivateArchivedThreads(
channelId: Snowflake
query?: RESTGetAPIChannelThreadsArchivedQuery
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIChannelUsersThreadsArchivedResult>

Fetches the private joined archived threads of a channel

See also: https://discord.com/developers/docs/resources/channel#list-joined-private-archived-threads

getMessage(
channelId: Snowflake
messageId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APIMessage>

Fetches a message

See also: https://discord.com/developers/docs/resources/message#get-channel-message

getMessageReactions(
channelId: Snowflake
messageId: Snowflake
emoji: string
query?: RESTGetAPIChannelMessageReactionUsersQuery
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIChannelMessageReactionUsersResult>

Fetches the reactions for a message

Examples:
// Unicode.
await api.channels.getMessageReactions('1234567890', '1234567890', '👍');

// Custom emoji.
await api.channels.getMessageReactions('1234567890', '1234567890', 'emoji_name:1234567890');

See also: https://discord.com/developers/docs/resources/message#get-reactions

getMessages(
channelId: Snowflake
query?: RESTGetAPIChannelMessagesQuery
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIChannelMessagesResult>

Fetches the messages of a channel

See also: https://discord.com/developers/docs/resources/message#get-channel-messages

getPins(
channelId: Snowflake
query?: RESTGetAPIChannelMessagesPinsQuery
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIChannelMessagesPinsResult>

Fetches pinned messages of a channel

See also: https://discord.com/developers/docs/resources/message#get-channel-pins

getWebhooks(
channelId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<RESTGetAPIChannelWebhooksResult>

Fetches the webhooks of a channel

See also: https://discord.com/developers/docs/resources/webhook#get-channel-webhooks

pinMessage(
channelId: Snowflake
messageId: Snowflake
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<void>

Pins a message in a channel

See also: https://discord.com/developers/docs/resources/message#pin-message

removeGroupDMRecipient(
channelId: Snowflake
userId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<void>

Removes a recipient from a group DM channel

See also: https://discord.com/developers/docs/resources/channel#group-dm-remove-recipient

sendSoundboardSound(
channelId: Snowflake
body: RESTPostAPISoundboardSendSoundJSONBody
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<APISoundboardSound>

Sends a soundboard sound in a channel

See also: https://discord.com/developers/docs/resources/soundboard#send-soundboard-sound

showTyping(
channelId: Snowflake
options?: Pick<RequestData, 'auth' | 'signal'>
) : Promise<void>

Shows a typing indicator in a channel

See also: https://discord.com/developers/docs/resources/channel#trigger-typing-indicator

unpinMessage(
channelId: Snowflake
messageId: Snowflake
options?: Pick<RequestData, 'auth' | 'reason' | 'signal'>
) : Promise<void>

Unpins a message in a channel

See also: https://discord.com/developers/docs/resources/message#unpin-message