discord.js | ChannelsAPI

/

/

/

/

/

ChannelsAPI%3AClass

Search...

K

ChannelsAPI

declare class ChannelsAPI

declare class ChannelsAPI

No summary provided.

constructor(rest)

Constructs a new instance of the ChannelsAPI class

Name	Type	Optional	Description
rest	REST	No	None

addMessageReaction(channelId, messageId, emoji):Promise<void>

Adds a reaction to a message

See Also

https://discord.com/developers/docs/resources/channel#create-reaction

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel the message is in
messageId	Snowflake	No	The id of the message to add the reaction to
emoji	string	No	The emoji to add the reaction with

bulkDeleteMessages(channelId, messageIds, reason?):Promise<void>

Bulk deletes messages

See Also

https://discord.com/developers/docs/resources/channel#bulk-delete-messages

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel the messages are in
messageIds	Snowflake[]	No	The ids of the messages to delete
reason	string	Yes	None

createInvite(channelId, data, reason?):Promise<discord_api_types_v10.APIExtendedInvite>

Creates a new invite for a channel

See Also

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

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to create an invite for
data	RESTPostAPIChannelInviteJSONBody	No	The data to use when creating the invite
reason	string	Yes	None

createMessage(channelId, data):Promise<discord_api_types_v10.APIMessage>

Sends a message in a channel

See Also

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

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to send the message in
data	RESTPostAPIChannelMessageJSONBody & { files?: RawFile[]; }	No	The data to use when sending the message

crosspostMessage(channelId, messageId):Promise<discord_api_types_v10.APIMessage>

Crossposts a message

See Also

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

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel the message is in
messageId	Snowflake	No	The id of the message to crosspost

delete(channelId):Promise<discord_api_types_v10.APIChannel>

Deletes a channel

See Also

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

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to delete

deleteAllMessageReactions(channelId, messageId):Promise<void>

Deletes all reactions for a message

See Also

https://discord.com/developers/docs/resources/channel#delete-all-reactions

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel the message is in
messageId	Snowflake	No	The id of the message to delete the reactions for

deleteAllMessageReactionsForEmoji(channelId, messageId, emoji):Promise<void>

Deletes all reactions of an emoji for a message

See Also

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

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel the message is in
messageId	Snowflake	No	The id of the message to delete the reactions for
emoji	string	No	The emoji to delete the reactions for

deleteMessage(channelId, messageId, reason?):Promise<void>

Deletes a message

See Also

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

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel the message is in
messageId	Snowflake	No	The id of the message to delete
reason	string	Yes	The reason for deleting the message

deleteOwnMessageReaction(channelId, messageId, emoji):Promise<void>

Deletes a reaction for the current user

See Also

https://discord.com/developers/docs/resources/channel#delete-own-reaction

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel the message is in
messageId	Snowflake	No	The id of the message to delete the reaction for
emoji	string	No	The emoji to delete the reaction for

deleteUserMessageReaction(channelId, messageId, emoji, userId):Promise<void>

Deletes a reaction for a user

See Also

https://discord.com/developers/docs/resources/channel#delete-user-reaction

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel the message is in
messageId	Snowflake	No	The id of the message to delete the reaction for
emoji	string	No	The emoji to delete the reaction for
userId	Snowflake	No	The id of the user to delete the reaction for

edit(channelId, data):Promise<discord_api_types_v10.APIChannel>

Edits a channel

See Also

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

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to edit
data	RESTPatchAPIChannelJSONBody	No	The new channel data

editMessage(channelId, messageId, data):Promise<discord_api_types_v10.APIMessage>

Edits a message

See Also

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

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel the message is in
messageId	Snowflake	No	The id of the message to edit
data	RESTPostAPIChannelMessageJSONBody & { files?: RawFile[]; }	No	The data to use when editing the message

followAnnouncements(channelId, webhookChannelId):Promise<discord_api_types_v10.APIFollowedChannel>

Follows an announcement channel

See Also

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

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the announcement channel to follow
webhookChannelId	Snowflake	No	The id of the webhook channel to follow the announcements in

get(channelId):Promise<discord_api_types_v10.APIChannel>

Fetches a channel

See Also

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

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel

getArchivedThreads(channelId, archivedStatus, options?):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

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to fetch archived threads from
archivedStatus	'private' \| 'public'	No	The archived status of the threads to fetch
options	RESTGetAPIChannelThreadsArchivedQuery	Yes	The options to use when fetching archived threads

getInvites(channelId):Promise<RESTGetAPIChannelInvitesResult>

Fetches the invites of a channel

See Also

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

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to fetch invites from

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

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to fetch joined archived threads from
options	RESTGetAPIChannelThreadsArchivedQuery	Yes	The options to use when fetching joined archived threads

getMessage(channelId, messageId):Promise<discord_api_types_v10.APIMessage>

Fetches a message

See Also

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

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel the message is in
messageId	Snowflake	No	The id of the message to fetch

getMessageReactions(channelId, messageId, emoji, options?):Promise<RESTGetAPIChannelMessageReactionUsersResult>

Fetches the reactions for a message

See Also

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

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel the message is in
messageId	Snowflake	No	The id of the message to get the reactions for
emoji	string	No	The emoji to get the reactions for
options	RESTGetAPIChannelMessageReactionUsersQuery	Yes	The options to use when fetching the reactions

getMessages(channelId, options?):Promise<RESTGetAPIChannelMessagesResult>

Fetches the messages of a channel

See Also

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

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to fetch messages from
options	RESTGetAPIChannelMessagesQuery	Yes	The options to use when fetching messages

getPins(channelId):Promise<RESTGetAPIChannelPinsResult>

Fetches the pinned messages of a channel

See Also

https://discord.com/developers/docs/resources/channel#get-pinned-messages

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to fetch pinned messages from

pinMessage(channelId, messageId, reason?):Promise<void>

Pins a message in a channel

See Also

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

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to pin the message in
messageId	Snowflake	No	The id of the message to pin
reason	string	Yes	The reason for pinning the message

showTyping(channelId):Promise<void>

Shows a typing indicator in a channel

See Also

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

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to show the typing indicator in

unpinMessage(channelId, messageId, reason?):Promise<void>

Unpins a message in a channel

See Also

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

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to unpin the message in
messageId	Snowflake	No	The id of the message to unpin
reason	string	Yes	The reason for unpinning the message