Package net.dv8tion.jda.api.entities
Interface TextChannel
-
- All Superinterfaces:
BaseGuildMessageChannel
,Channel
,Comparable<GuildChannel>
,Formattable
,GuildChannel
,GuildMessageChannel
,ICategorizableChannel
,ICopyableChannel
,IInviteContainer
,IMemberContainer
,IMentionable
,IPermissionContainer
,IPositionableChannel
,ISnowflake
,IThreadContainer
,MessageChannel
public interface TextChannel extends BaseGuildMessageChannel
Represents a Discord Text GuildChannel.
Adds additional functionality and information for text channels in Discord.This is a
GuildChannel
capable of sending messages.- See Also:
GuildChannel
,MessageChannel
,VoiceChannel
,Category
,Guild.getTextChannelCache()
,Guild.getTextChannels()
,Guild.getTextChannelsByName(String, boolean)
,Guild.getTextChannelById(long)
,JDA.getTextChannelCache()
,JDA.getTextChannels()
,JDA.getTextChannelsByName(String, boolean)
,JDA.getTextChannelById(long)
-
-
Field Summary
Fields Modifier and Type Field Description static int
MAX_SLOWMODE
The maximum duration of slowmode in seconds
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default ChannelAction<TextChannel>
createCopy()
Creates a copy of the specifiedGuildChannel
.ChannelAction<TextChannel>
createCopy(Guild guild)
Creates a copy of the specifiedGuildChannel
in the specifiedGuild
.TextChannelManager
getManager()
Returns theChannelManager
for this GuildChannel.int
getSlowmode()
The slowmode set for this TextChannel.-
Methods inherited from interface net.dv8tion.jda.api.entities.BaseGuildMessageChannel
createWebhook, deleteWebhookById, getTopic, isNSFW, retrieveWebhooks
-
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, getPermissionContainer
-
Methods inherited from interface net.dv8tion.jda.api.entities.GuildMessageChannel
canTalk, canTalk, clearReactionsById, clearReactionsById, clearReactionsById, clearReactionsById, clearReactionsById, clearReactionsById, deleteMessages, deleteMessagesByIds, removeReactionById, removeReactionById, removeReactionById, removeReactionById
-
Methods inherited from interface net.dv8tion.jda.api.entities.ICategorizableChannel
getParentCategory, getParentCategoryId, getParentCategoryIdLong, isSynced
-
Methods inherited from interface net.dv8tion.jda.api.entities.IInviteContainer
createInvite, retrieveInvites
-
Methods inherited from interface net.dv8tion.jda.api.entities.IMemberContainer
getMembers
-
Methods inherited from interface net.dv8tion.jda.api.entities.IPermissionContainer
createPermissionOverride, getMemberPermissionOverrides, getPermissionOverride, getPermissionOverrides, getRolePermissionOverrides, putPermissionOverride, upsertPermissionOverride
-
Methods inherited from interface net.dv8tion.jda.api.entities.IPositionableChannel
getPosition, getPositionRaw
-
Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake
getId, getIdLong, getTimeCreated
-
Methods inherited from interface net.dv8tion.jda.api.entities.IThreadContainer
createThreadChannel, createThreadChannel, createThreadChannel, createThreadChannel, getThreadChannels, retrieveArchivedPrivateJoinedThreadChannels, retrieveArchivedPrivateThreadChannels, retrieveArchivedPublicThreadChannels
-
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
-
-
-
-
Field Detail
-
MAX_SLOWMODE
static final int MAX_SLOWMODE
The maximum duration of slowmode in seconds- See Also:
- Constant Field Values
-
-
Method Detail
-
getSlowmode
int getSlowmode()
The slowmode set for this TextChannel.
If slowmode is set this returns anint
between 1 andTextChannel.MAX_SLOWMODE
.
If not set this returns0
.Note bots are unaffected by this.
HavingMESSAGE_MANAGE
orMANAGE_CHANNEL
permission also grants immunity to slowmode.- Returns:
- The slowmode for this TextChannel, between 1 and
TextChannel.MAX_SLOWMODE
, or0
if no slowmode is set.
-
createCopy
@Nonnull ChannelAction<TextChannel> createCopy(@Nonnull Guild guild)
Description copied from interface:ICopyableChannel
Creates a copy of the specifiedGuildChannel
in the specifiedGuild
.
If the provided target guild is not the same Guild this channel is in then the parent category and permissions will not be copied due to technical difficulty and ambiguity.This copies the following elements:
- Name
- Parent Category (if present)
- Voice Elements (Bitrate, Userlimit)
- Text Elements (Topic, NSFW, Slowmode)
- All permission overrides for Members/Roles
Possible
ErrorResponses
caused by the returnedRestAction
include the following:MISSING_PERMISSIONS
The channel could not be created due to a permission discrepancyMISSING_ACCESS
TheVIEW_CHANNEL
permission was removed
- Specified by:
createCopy
in interfaceBaseGuildMessageChannel
- Specified by:
createCopy
in interfaceICopyableChannel
- Parameters:
guild
- TheGuild
to create the channel in- Returns:
- A specific
ChannelAction
This action allows to set fields for the new GuildChannel before creating it!
-
createCopy
@Nonnull default ChannelAction<TextChannel> createCopy()
Description copied from interface:ICopyableChannel
Creates a copy of the specifiedGuildChannel
.This copies the following elements:
- Name
- Parent Category (if present)
- Voice Elements (Bitrate, Userlimit)
- Text Elements (Topic, NSFW, Slowmode)
- All permission overrides for Members/Roles
Possible
ErrorResponses
caused by the returnedRestAction
include the following:MISSING_PERMISSIONS
The channel could not be created due to a permission discrepancyMISSING_ACCESS
TheVIEW_CHANNEL
permission was removed
- Specified by:
createCopy
in interfaceBaseGuildMessageChannel
- Specified by:
createCopy
in interfaceICopyableChannel
- Returns:
- A specific
ChannelAction
This action allows to set fields for the new GuildChannel before creating it!
-
getManager
@Nonnull TextChannelManager getManager()
Description copied from interface:GuildChannel
Returns theChannelManager
for this GuildChannel.
In the ChannelManager, you can modify the name, topic and position of this GuildChannel. You modify multiple fields in one request by chaining setters before callingRestAction.queue()
.This is a lazy idempotent getter. The manager is retained after the first call. This getter is not thread-safe and would require guards by the user.
- Specified by:
getManager
in interfaceBaseGuildMessageChannel
- Specified by:
getManager
in interfaceGuildChannel
- Specified by:
getManager
in interfaceICategorizableChannel
- Specified by:
getManager
in interfaceIPermissionContainer
- Specified by:
getManager
in interfaceIPositionableChannel
- Returns:
- The ChannelManager of this GuildChannel
-
-