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 standard Discord Text GuildChannel.
Adds additional functionality and information for text channels in Discord, on top of the common functionality present in other guild message channels.

This is a GuildChannel capable of sending messages.

See Also:

• GuildChannel
• MessageChannel
• BaseGuildMessageChannel
• 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 final int	MAX_SLOWMODE	The maximum duration of slowmode in seconds

Method Summary

Modifier and Type	Method	Description
default ChannelAction<TextChannel>	createCopy()	Creates a copy of the specified GuildChannel.
ChannelAction<TextChannel>	createCopy(Guild guild)	Creates a copy of the specified GuildChannel in the specified Guild.
TextChannelManager	getManager()	Returns the ChannelManager 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 Details

MAX_SLOWMODE

static final int MAX_SLOWMODE

The maximum duration of slowmode in seconds

See Also:

• Constant Field Values

Method Details

getSlowmode

int getSlowmode()

The slowmode set for this TextChannel.
If slowmode is set this returns an int between 1 and TextChannel.MAX_SLOWMODE.
If not set this returns 0.

Note bots are unaffected by this.
Having MESSAGE_MANAGE or MANAGE_CHANNEL permission also grants immunity to slowmode.

Returns:

The slowmode for this TextChannel, between 1 and TextChannel.MAX_SLOWMODE, or 0 if no slowmode is set.

createCopy

@Nonnull
ChannelAction<TextChannel> createCopy(@Nonnull
 Guild guild)

Description copied from interface: ICopyableChannel

Creates a copy of the specified GuildChannel in the specified Guild.
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:

1. Name
2. Parent Category (if present)
3. Voice Elements (Bitrate, Userlimit)
4. Text Elements (Topic, NSFW, Slowmode)
5. All permission overrides for Members/Roles

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MISSING_ACCESS
  The VIEW_CHANNEL permission was removed

Specified by:

createCopy in interface BaseGuildMessageChannel

Specified by:

createCopy in interface ICopyableChannel

Parameters:

guild - The Guild 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 specified GuildChannel.

This copies the following elements:

1. Name
2. Parent Category (if present)
3. Voice Elements (Bitrate, Userlimit)
4. Text Elements (Topic, NSFW, Slowmode)
5. All permission overrides for Members/Roles

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MISSING_ACCESS
  The VIEW_CHANNEL permission was removed

Specified by:

createCopy in interface BaseGuildMessageChannel

Specified by:

createCopy in interface ICopyableChannel

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 the ChannelManager 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 calling RestAction.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 interface BaseGuildMessageChannel

Specified by:

getManager in interface GuildChannel

Specified by:

getManager in interface ICategorizableChannel

Specified by:

getManager in interface IPermissionContainer

Specified by:

getManager in interface IPositionableChannel

Returns:

The ChannelManager of this GuildChannel