Package net.dv8tion.jda.api.entities

Interface GuildMessageChannel

All Superinterfaces:

Channel, Comparable<GuildChannel>, Formattable, GuildChannel, IMentionable, ISnowflake, MessageChannel

All Known Subinterfaces:

BaseGuildMessageChannel, NewsChannel, TextChannel, ThreadChannel

public interface GuildMessageChannel
extends GuildChannel, MessageChannel

Represents all message channels present in guilds. This includes channels that are not included in BaseGuildMessageChannel, such as ThreadChannel.

See Also:

• BaseGuildMessageChannel

Method Summary

Modifier and Type	Method	Description
default boolean	canTalk()	Whether the currently logged in user can send messages in this channel or not.
boolean	canTalk(Member member)	Whether the specified Member can send messages in this channel.
default RestAction<Void>	clearReactionsById(long messageId)	Attempts to remove all reactions from a message with the specified messageId in this TextChannel This is useful for moderator commands that wish to remove all reactions at once from a specific message.
default RestAction<Void>	clearReactionsById(long messageId, String unicode)	Removes all reactions for the specified emoji.
default RestAction<Void>	clearReactionsById(long messageId, Emote emote)	Removes all reactions for the specified emoji.
RestAction<Void>	clearReactionsById(String messageId)	Attempts to remove all reactions from a message with the specified messageId in this TextChannel This is useful for moderator commands that wish to remove all reactions at once from a specific message.
RestAction<Void>	clearReactionsById(String messageId, String unicode)	Removes all reactions for the specified emoji.
default RestAction<Void>	clearReactionsById(String messageId, Emote emote)	Removes all reactions for the specified emoji.
default RestAction<Void>	deleteMessages(Collection<Message> messages)	Bulk deletes a list of messages.
RestAction<Void>	deleteMessagesByIds(Collection<String> messageIds)	Bulk deletes a list of messages.
default RestAction<Void>	removeReactionById(long messageId, String unicode, User user)	Attempts to remove the reaction from a message represented by the specified messageId in this MessageChannel.
default RestAction<Void>	removeReactionById(long messageId, Emote emote, User user)	Attempts to remove the reaction from a message represented by the specified messageId in this MessageChannel.
RestAction<Void>	removeReactionById(String messageId, String unicode, User user)	Attempts to remove the reaction from a message represented by the specified messageId in this MessageChannel.
default RestAction<Void>	removeReactionById(String messageId, Emote emote, User user)	Attempts to remove the reaction from a message represented by the specified messageId in this MessageChannel.

Methods inherited from interface net.dv8tion.jda.api.entities.Channel

formatTo, getAsMention, getJDA, getName, getType

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface net.dv8tion.jda.api.entities.GuildChannel

delete, getGuild, getManager, getPermissionContainer

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getIdLong, getTimeCreated

Methods inherited from interface net.dv8tion.jda.api.entities.MessageChannel

addReactionById, addReactionById, addReactionById, addReactionById, deleteMessageById, deleteMessageById, editMessageById, editMessageById, editMessageById, editMessageById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageEmbedsById, editMessageEmbedsById, editMessageEmbedsById, editMessageEmbedsById, editMessageFormatById, editMessageFormatById, getHistory, getHistoryAfter, getHistoryAfter, getHistoryAfter, getHistoryAround, getHistoryAround, getHistoryAround, getHistoryBefore, getHistoryBefore, getHistoryBefore, getHistoryFromBeginning, getIterableHistory, getLatestMessageId, getLatestMessageIdLong, hasLatestMessage, pinMessageById, pinMessageById, purgeMessages, purgeMessages, purgeMessagesById, purgeMessagesById, purgeMessagesById, removeReactionById, removeReactionById, removeReactionById, removeReactionById, retrieveMessageById, retrieveMessageById, retrievePinnedMessages, retrieveReactionUsersById, retrieveReactionUsersById, retrieveReactionUsersById, retrieveReactionUsersById, sendFile, sendFile, sendFile, sendFile, sendMessage, sendMessage, sendMessageEmbeds, sendMessageEmbeds, sendMessageFormat, sendTyping, unpinMessageById, unpinMessageById

Method Details

canTalk

default boolean canTalk()

Description copied from interface: MessageChannel

Whether the currently logged in user can send messages in this channel or not.
For GuildMessageChannel this method checks for both Permission.VIEW_CHANNEL and Permission.MESSAGE_SEND.
For ThreadChannel this method checks for Permission.MESSAGE_SEND_IN_THREADS instead of Permission.MESSAGE_SEND.
For PrivateChannel this method checks if the user that this PrivateChannel communicates with is not a bot, but it does not check if the said user blocked the currently logged in user or have their DMs disabled.

Specified by:

canTalk in interface MessageChannel

Returns:

True, if we are able to read and send messages in this channel

canTalk

boolean canTalk(@Nonnull
 Member member)

Whether the specified Member can send messages in this channel.
Checks for both Permission.VIEW_CHANNEL and Permission.MESSAGE_SEND.

Parameters:

member - The Member to check

Returns:

True, if the specified member is able to read and send messages in this channel

removeReactionById

@Nonnull
@CheckReturnValue
RestAction<Void> removeReactionById(@Nonnull
 String messageId,
 @Nonnull
 String unicode,
 @Nonnull
 User user)

Attempts to remove the reaction from a message represented by the specified messageId in this MessageChannel.

The unicode provided has to be a unicode representation of the emoji that is supposed to be represented by the Reaction.
To retrieve the characters needed you can use an api or the official discord client by escaping the emoji (\:emoji-name:) and copying the resulting emoji from the sent message.

This method encodes the provided unicode for you. Do not encode the emoji before providing the unicode.

The following ErrorResponses are possible:

• MISSING_ACCESS
  The request was attempted after the account lost access to the Guild typically due to being kicked or removed, or after Permission.VIEW_CHANNEL was revoked in the TextChannel
  Also can happen if the account lost the Permission.MESSAGE_HISTORY
• MISSING_PERMISSIONS
  The request was attempted after the account lost Permission.MESSAGE_ADD_REACTION in the TextChannel.
• ErrorResponse.UNKNOWN_EMOJI
  The provided unicode character does not refer to a known emoji unicode character.
  Proper unicode characters for emojis can be found here: Emoji Table
• UNKNOWN_MESSAGE
  The provided messageId is unknown in this MessageChannel, either due to the id being invalid, or the message it referred to has already been deleted.
• UNKNOWN_CHANNEL
  The request was attempted after the channel was deleted.

Parameters:

messageId - The messageId to remove the reaction from

unicode - The unicode characters of the emoji

user - The target user of which to remove from

Returns:

RestAction

Throws:

IllegalArgumentException -

• If provided messageId is null or empty.
• If provided unicode is null or empty.

InsufficientPermissionException - If the currently logged in account does not have Permission.MESSAGE_MANAGE in this channel.

removeReactionById

@Nonnull
@CheckReturnValue
default RestAction<Void> removeReactionById(long messageId,
 @Nonnull
 String unicode,
 @Nonnull
 User user)

Attempts to remove the reaction from a message represented by the specified messageId in this MessageChannel.

The unicode provided has to be a unicode representation of the emoji that is supposed to be represented by the Reaction.
To retrieve the characters needed you can use an api or the official discord client by escaping the emoji (\:emoji-name:) and copying the resulting emoji from the sent message.

This method encodes the provided unicode for you. Do not encode the emoji before providing the unicode.

The following ErrorResponses are possible:

• MISSING_ACCESS
  The request was attempted after the account lost access to the Guild typically due to being kicked or removed, or after Permission.VIEW_CHANNEL was revoked in the TextChannel
  Also can happen if the account lost the Permission.MESSAGE_HISTORY
• MISSING_PERMISSIONS
  The request was attempted after the account lost Permission.MESSAGE_ADD_REACTION in the TextChannel.
• ErrorResponse.UNKNOWN_EMOJI
  The provided unicode character does not refer to a known emoji unicode character.
  Proper unicode characters for emojis can be found here: Emoji Table
• UNKNOWN_MESSAGE
  The provided messageId is unknown in this MessageChannel, either due to the id being invalid, or the message it referred to has already been deleted.
• UNKNOWN_CHANNEL
  The request was attempted after the channel was deleted.

Parameters:

messageId - The messageId to remove the reaction from

unicode - The unicode characters of the emoji

user - The target user of which to remove from

Returns:

RestAction

Throws:

IllegalArgumentException -

• If provided messageId is null or empty.
• If provided unicode is null or empty.

InsufficientPermissionException - If the currently logged in account does not have Permission.MESSAGE_MANAGE in this channel.

removeReactionById

@Nonnull
@CheckReturnValue
default RestAction<Void> removeReactionById(@Nonnull
 String messageId,
 @Nonnull
 Emote emote,
 @Nonnull
 User user)

Attempts to remove the reaction from a message represented by the specified messageId in this MessageChannel.

An Emote is not the same as an emoji!
Emotes are custom guild-specific images unlike global unicode emojis!

The following ErrorResponses are possible:

• MISSING_ACCESS
  The request was attempted after the account lost access to the Guild typically due to being kicked or removed, or after Permission.VIEW_CHANNEL was revoked in the TextChannel
  Also can happen if the account lost the Permission.MESSAGE_HISTORY
• MISSING_PERMISSIONS
  The request was attempted after the account lost Permission.MESSAGE_ADD_REACTION in the TextChannel.
• ErrorResponse.UNKNOWN_EMOJI
  The provided unicode character does not refer to a known emoji unicode character.
  Proper unicode characters for emojis can be found here: Emoji Table
• UNKNOWN_MESSAGE
  The provided messageId is unknown in this MessageChannel, either due to the id being invalid, or the message it referred to has already been deleted.
• UNKNOWN_CHANNEL
  The request was attempted after the channel was deleted.

Parameters:

messageId - The messageId to remove the reaction from

emote - The emote to remove

user - The target user of which to remove from

Returns:

RestAction

Throws:

IllegalArgumentException -

• If provided messageId is null or empty.
• If provided emote is null.

InsufficientPermissionException - If the currently logged in account does not have Permission.MESSAGE_MANAGE in this channel.

removeReactionById

@Nonnull
@CheckReturnValue
default RestAction<Void> removeReactionById(long messageId,
 @Nonnull
 Emote emote,
 @Nonnull
 User user)

Attempts to remove the reaction from a message represented by the specified messageId in this MessageChannel.

An Emote is not the same as an emoji!
Emotes are custom guild-specific images unlike global unicode emojis!

The following ErrorResponses are possible:

• MISSING_ACCESS
  The request was attempted after the account lost access to the Guild typically due to being kicked or removed, or after Permission.VIEW_CHANNEL was revoked in the TextChannel
  Also can happen if the account lost the Permission.MESSAGE_HISTORY
• MISSING_PERMISSIONS
  The request was attempted after the account lost Permission.MESSAGE_ADD_REACTION in the TextChannel.
• ErrorResponse.UNKNOWN_EMOJI
  The provided unicode character does not refer to a known emoji unicode character.
  Proper unicode characters for emojis can be found here: Emoji Table
• UNKNOWN_MESSAGE
  The provided messageId is unknown in this MessageChannel, either due to the id being invalid, or the message it referred to has already been deleted.
• UNKNOWN_CHANNEL
  The request was attempted after the channel was deleted.

Parameters:

messageId - The messageId to remove the reaction from

emote - The emote to remove

user - The target user of which to remove from

Returns:

RestAction

Throws:

IllegalArgumentException -

• If provided messageId is null or empty.
• If provided emote is null.

InsufficientPermissionException - If the currently logged in account does not have Permission.MESSAGE_MANAGE in this channel.

deleteMessages

@Nonnull
@CheckReturnValue
default RestAction<Void> deleteMessages(@Nonnull
 Collection<Message> messages)

Bulk deletes a list of messages. This is not the same as calling Message.delete() in a loop.
This is much more efficient, but it has a different ratelimit. You may call this once per second per Guild.

Must be at least 2 messages and not be more than 100 messages at a time.
If you only have 1 message, use the Message.delete() method instead.

You must have the Permission MESSAGE_MANAGE in this channel to use this function.

This method is best used when using MessageHistory to delete a large amount of messages. If you have a large amount of messages but only their message Ids, please use deleteMessagesByIds(Collection)

Possible ErrorResponses include:

• UNKNOWN_CHANNEL
  if this channel was deleted
• UNKNOWN_MESSAGE
  if any of the provided messages does not exist
• MISSING_ACCESS
  if we were removed from the guild
• MISSING_PERMISSIONS
  The send request was attempted after the account lost Permission.MESSAGE_MANAGE in the channel.

Parameters:

messages - The collection of messages to delete.

Returns:

AuditableRestAction

Throws:

IllegalArgumentException - If the size of the list less than 2 or more than 100 messages.

InsufficientPermissionException - If this account does not have Permission.MESSAGE_MANAGE

See Also:

• deleteMessagesByIds(Collection)
• MessageChannel.purgeMessages(List)

deleteMessagesByIds

@Nonnull
@CheckReturnValue
RestAction<Void> deleteMessagesByIds(@Nonnull
 Collection<String> messageIds)

Bulk deletes a list of messages. This is not the same as calling MessageChannel.deleteMessageById(String) in a loop.
This is much more efficient, but it has a different ratelimit. You may call this once per second per Guild.

Must be at least 2 messages and not be more than 100 messages at a time.
If you only have 1 message, use the Message.delete() method instead.

You must have Permission.MESSAGE_MANAGE in this channel to use this function.

This method is best used when you have a large amount of messages but only their message Ids. If you are using MessageHistory or have Message objects, it would be easier to use deleteMessages(java.util.Collection).

Possible ErrorResponses include:

• UNKNOWN_CHANNEL
  if this channel was deleted
• UNKNOWN_MESSAGE
  if any of the provided messages does not exist
• MISSING_ACCESS
  if we were removed from the guild
• MISSING_PERMISSIONS
  The send request was attempted after the account lost Permission.MESSAGE_MANAGE in the channel.

Parameters:

messageIds - The message ids for the messages to delete.

Returns:

AuditableRestAction

Throws:

IllegalArgumentException - If the size of the list less than 2 or more than 100 messages.

NumberFormatException - If any of the provided ids cannot be parsed by Long.parseLong(String)

InsufficientPermissionException - If this account does not have Permission.MESSAGE_MANAGE

See Also:

• deleteMessages(Collection)
• MessageChannel.purgeMessagesById(List)

clearReactionsById

@Nonnull
@CheckReturnValue
RestAction<Void> clearReactionsById(@Nonnull
 String messageId)

Attempts to remove all reactions from a message with the specified messageId in this TextChannel
This is useful for moderator commands that wish to remove all reactions at once from a specific message.

The following ErrorResponses are possible:

• MISSING_ACCESS
  The clear-reactions request was attempted after the account lost access to the TextChannel due to Permission.VIEW_CHANNEL being revoked, or the account lost access to the Guild typically due to being kicked or removed.
• MISSING_PERMISSIONS
  The clear-reactions request was attempted after the account lost Permission.MESSAGE_MANAGE in the TextChannel when adding the reaction.
• UNKNOWN_MESSAGE The clear-reactions request was attempted after the Message had been deleted.

Parameters:

messageId - The not-empty valid message id

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MESSAGE_MANAGE in this channel.

IllegalArgumentException - If the provided id is null or empty.

clearReactionsById

@Nonnull
@CheckReturnValue
default RestAction<Void> clearReactionsById(long messageId)

Attempts to remove all reactions from a message with the specified messageId in this TextChannel
This is useful for moderator commands that wish to remove all reactions at once from a specific message.

The following ErrorResponses are possible:

• MISSING_ACCESS
  The clear-reactions request was attempted after the account lost access to the TextChannel due to Permission.VIEW_CHANNEL being revoked, or the account lost access to the Guild typically due to being kicked or removed.
• MISSING_PERMISSIONS
  The clear-reactions request was attempted after the account lost Permission.MESSAGE_MANAGE in the TextChannel when adding the reaction.
• UNKNOWN_MESSAGE The clear-reactions request was attempted after the Message had been deleted.

Parameters:

messageId - The message id

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MESSAGE_MANAGE in this channel.

clearReactionsById

@Nonnull
@CheckReturnValue
RestAction<Void> clearReactionsById(@Nonnull
 String messageId,
 @Nonnull
 String unicode)

Removes all reactions for the specified emoji.

Example

 // custom
 channel.clearReactions(messageId, "minn:245267426227388416").queue();
 // unicode escape
 channel.clearReactions(messageId, "\uD83D\uDE02").queue();
 // codepoint notation
 channel.clearReactions(messageId, "U+1F602").queue();
 

The following ErrorResponses are possible:

• MISSING_ACCESS
  The currently logged in account lost access to the channel by either being removed from the guild or losing the VIEW_CHANNEL permission
• UNKNOWN_EMOJI
  The provided unicode emoji doesn't exist. Try using one of the example formats.
• UNKNOWN_MESSAGE
  The message was deleted.

Parameters:

messageId - The id for the target message

unicode - The unicode emoji to remove reactions for

Returns:

RestAction

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MESSAGE_MANAGE in the channel

IllegalArgumentException - If provided with null

Since:

4.2.0

clearReactionsById

@Nonnull
@CheckReturnValue
default RestAction<Void> clearReactionsById(@Nonnull
 String messageId,
 @Nonnull
 Emote emote)

Removes all reactions for the specified emoji.

The following ErrorResponses are possible:

• MISSING_ACCESS
  The currently logged in account lost access to the channel by either being removed from the guild or losing the VIEW_CHANNEL permission
• UNKNOWN_EMOJI
  The provided Emote was deleted or doesn't exist.
• UNKNOWN_MESSAGE
  The message was deleted.

Parameters:

messageId - The id for the target message

emote - The Emote to remove reactions for

Returns:

RestAction

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MESSAGE_MANAGE in the channel

IllegalArgumentException - If provided with null

Since:

4.2.0

clearReactionsById

@Nonnull
@CheckReturnValue
default RestAction<Void> clearReactionsById(long messageId,
 @Nonnull
 String unicode)

Removes all reactions for the specified emoji.

Example

 // custom
 channel.clearReactions(messageId, "minn:245267426227388416").queue();
 // unicode escape
 channel.clearReactions(messageId, "\uD83D\uDE02").queue();
 // codepoint notation
 channel.clearReactions(messageId, "U+1F602").queue();
 

The following ErrorResponses are possible:

• MISSING_ACCESS
  The currently logged in account lost access to the channel by either being removed from the guild or losing the VIEW_CHANNEL permission
• UNKNOWN_EMOJI
  The provided unicode emoji doesn't exist. Try using one of the example formats.
• UNKNOWN_MESSAGE
  The message was deleted.

Parameters:

messageId - The id for the target message

unicode - The unicode emoji to remove reactions for

Returns:

RestAction

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MESSAGE_MANAGE in the channel

IllegalArgumentException - If provided with null

Since:

4.2.0

clearReactionsById

@Nonnull
@CheckReturnValue
default RestAction<Void> clearReactionsById(long messageId,
 @Nonnull
 Emote emote)

Removes all reactions for the specified emoji.

The following ErrorResponses are possible:

• MISSING_ACCESS
  The currently logged in account lost access to the channel by either being removed from the guild or losing the VIEW_CHANNEL permission
• UNKNOWN_EMOJI
  The provided Emote was deleted or doesn't exist.
• UNKNOWN_MESSAGE
  The message was deleted.

Parameters:

messageId - The id for the target message

emote - The Emote to remove reactions for

Returns:

RestAction

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MESSAGE_MANAGE in the channel

IllegalArgumentException - If provided with null

Since:

4.2.0