discord.js | ChannelsAPI

Search...

ChannelsAPI

export declare class ChannelsAPI

export 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, options?):Promise<void>

Adds a reaction to a message

Example

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

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

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

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

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. URL encoding happens internally
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for adding the reaction

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
options	Pick<RequestData, 'auth' \| 'reason' \| 'signal'>	Yes	The options for deleting the messages

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the forum channel to start the thread in
body	StartForumThreadOptions	No	The data for starting the thread
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for starting the thread

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to create an invite for
body	RESTPostAPIChannelInviteJSONBody	No	The data for creating the invite
options	Pick<RequestData, 'auth' \| 'reason' \| 'signal'>	Yes	The options for creating the invite

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to send the message in
body	CreateMessageOptions	No	The data for sending the message
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for sending the message

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to start the thread in
body	RESTPostAPIChannelThreadsJSONBody	No	The data for starting the thread
messageId	Snowflake	Yes	The id of the message to start the thread from
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for starting the thread

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to create the webhook in
body	RESTPostAPIChannelWebhookJSONBody	No	The data for creating the webhook
options	Pick<RequestData, 'auth' \| 'reason' \| 'signal'>	Yes	The options for creating the webhook

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
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for crossposting the message

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to delete
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for deleting the channel

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
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for deleting the reactions

Example

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

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

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

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

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. URL encoding happens internally
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for deleting the 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
options	Pick<RequestData, 'auth' \| 'reason' \| 'signal'>	Yes	The options for deleting the message

Example

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

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

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

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

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. URL encoding happens internally
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for deleting the reaction

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to delete the permission overwrite in
overwriteId	Snowflake	No	The id of the user or role to delete the permission overwrite for
options	Pick<RequestData, 'auth' \| 'reason' \| 'signal'>	Yes	The options for deleting the permission overwrite

Example

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

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

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

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

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. URL encoding happens internally
userId	Snowflake	No	The id of the user to delete the reaction for
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for deleting the reaction

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to edit
body	RESTPatchAPIChannelJSONBody	No	The new channel data
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for editing the channel

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
body	EditMessageOptions	No	The data for editing the message
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for editing the message

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to edit the permission overwrite in
overwriteId	Snowflake	No	The id of the user or role to edit the permission overwrite for
body	RESTPutAPIChannelPermissionJSONBody	No	The data for editing the permission overwrite
options	Pick<RequestData, 'auth' \| 'reason' \| 'signal'>	Yes	The options for editing the permission overwrite

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
options	Pick<RequestData, 'auth' \| 'reason' \| 'signal'>	Yes	The options for following the announcement channel

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for fetching the channel

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
query	RESTGetAPIChannelThreadsArchivedQuery	Yes	The options for fetching archived threads
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for fetching archived threads

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to fetch invites from
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for fetching the invites

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to fetch joined archived threads from
query	RESTGetAPIChannelThreadsArchivedQuery	Yes	The options for fetching joined archived threads
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for fetching joined archived threads

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
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for fetching the message

Example

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

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

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

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

ChannelsAPI

Example

See Also

See Also

See Also

See Also

See Also

See Also

See Also

See Also

See Also

See Also

Example

See Also

See Also

Example

See Also

See Also

Example

See Also

See Also

See Also

See Also

See Also

See Also

See Also

See Also

See Also

See Also

Example

See Also

See Also

See Also

See Also

See Also

See Also

See Also

See Also

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to fetch messages from
query	RESTGetAPIChannelMessagesQuery	Yes	The query options for fetching messages
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for fetching the messages

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to fetch pinned messages from
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for fetching the pinned messages

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
options	Pick<RequestData, 'auth' \| 'reason' \| 'signal'>	Yes	The options for pinning the message

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to send the soundboard sound in
body	RESTPostAPISoundboardSendSoundJSONBody	No	The data for sending the soundboard sound
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for sending the soundboard sound

Name	Type	Optional	Description
channelId	Snowflake	No	The id of the channel to show the typing indicator in
options	Pick<RequestData, 'auth' \| 'signal'>	Yes	The options for showing the typing indicator

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
options	Pick<RequestData, 'auth' \| 'reason' \| 'signal'>	Yes	The options for unpinning the message