Interface TextChannel

All Superinterfaces:

Channel, Comparable<GuildChannel>, Formattable, GuildChannel, GuildMessageChannel, IAgeRestrictedChannel, ICategorizableChannel, ICopyableChannel, IDetachableEntity, IInviteContainer, IMemberContainer, IMentionable, IPermissionContainer, IPositionableChannel, ISlowmodeChannel, ISnowflake, IThreadContainer, IWebhookContainer, MessageChannel, StandardGuildChannel, StandardGuildMessageChannel

public interface TextChannel
extends StandardGuildMessageChannel, ISlowmodeChannel

Represents a 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
• StandardGuildMessageChannel
• Guild.getTextChannelCache()
• IGuildChannelContainer.getTextChannels()
• IGuildChannelContainer.getTextChannelsByName(String, boolean)
• IGuildChannelContainer.getTextChannelById(long)
• IGuildChannelContainer.getTextChannelCache()
• IGuildChannelContainer.getTextChannels()
• IGuildChannelContainer.getTextChannelsByName(String, boolean)
• IGuildChannelContainer.getTextChannelById(long)

Field Summary

Fields inherited from interface Channel

MAX_NAME_LENGTH

Fields inherited from interface GuildChannel

JUMP_URL

Fields inherited from interface ISlowmodeChannel

MAX_SLOWMODE

Fields inherited from interface StandardGuildMessageChannel

MAX_TOPIC_LENGTH

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.

Methods inherited from interface Channel

formatTo, getAsMention, getFlags, getJDA, getName, getType

Methods inherited from interface Comparable

compareTo

Methods inherited from interface GuildChannel

delete, getGuild, getJumpUrl, getPermissionContainer

Methods inherited from interface GuildMessageChannel

canTalk, canTalk, clearReactionsById, clearReactionsById, clearReactionsById, clearReactionsById, deleteMessages, deleteMessagesByIds, removeReactionById, removeReactionById, sendStickers, sendStickers

Methods inherited from interface IAgeRestrictedChannel

isNSFW

Methods inherited from interface ICategorizableChannel

getParentCategory, getParentCategoryId, getParentCategoryIdLong, getPositionInCategory, isSynced

Methods inherited from interface IDetachableEntity

isDetached

Methods inherited from interface IInviteContainer

createInvite, retrieveInvites

Methods inherited from interface IMemberContainer

getMembers

Methods inherited from interface IPermissionContainer

getMemberPermissionOverrides, getPermissionOverride, getPermissionOverrides, getRolePermissionOverrides, upsertPermissionOverride

Methods inherited from interface IPositionableChannel

getPosition, getPositionRaw

Methods inherited from interface ISlowmodeChannel

getSlowmode

Methods inherited from interface ISnowflake

getId, getIdLong, getTimeCreated

Methods inherited from interface IThreadContainer

createThreadChannel, createThreadChannel, createThreadChannel, createThreadChannel, getDefaultThreadSlowmode, getThreadChannels, retrieveArchivedPrivateJoinedThreadChannels, retrieveArchivedPrivateThreadChannels, retrieveArchivedPublicThreadChannels

Methods inherited from interface IWebhookContainer

createWebhook, deleteWebhookById, retrieveWebhooks

Methods inherited from interface MessageChannel

addReactionById, addReactionById, deleteMessageById, deleteMessageById, editMessageAttachmentsById, editMessageAttachmentsById, editMessageAttachmentsById, editMessageAttachmentsById, editMessageById, editMessageById, editMessageById, editMessageById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageEmbedsById, editMessageEmbedsById, editMessageEmbedsById, editMessageEmbedsById, editMessageFormatById, editMessageFormatById, endPollById, endPollById, getHistory, getHistoryAfter, getHistoryAfter, getHistoryAfter, getHistoryAround, getHistoryAround, getHistoryAround, getHistoryBefore, getHistoryBefore, getHistoryBefore, getHistoryFromBeginning, getIterableHistory, getLatestMessageId, getLatestMessageIdLong, pinMessageById, pinMessageById, purgeMessages, purgeMessages, purgeMessagesById, purgeMessagesById, purgeMessagesById, removeReactionById, removeReactionById, retrieveMessageById, retrieveMessageById, retrievePinnedMessages, retrievePollVotersById, retrievePollVotersById, retrieveReactionUsersById, retrieveReactionUsersById, retrieveReactionUsersById, retrieveReactionUsersById, sendFiles, sendFiles, sendMessage, sendMessage, sendMessageComponents, sendMessageComponents, sendMessageComponents, sendMessageEmbeds, sendMessageEmbeds, sendMessageFormat, sendMessagePoll, sendTyping, unpinMessageById, unpinMessageById

Methods inherited from interface StandardGuildMessageChannel

getTopic

Method Details

createCopy

@Nonnull
@CheckReturnValue
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 ICopyableChannel

Specified by:

createCopy in interface StandardGuildChannel

Specified by:

createCopy in interface StandardGuildMessageChannel

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
@CheckReturnValue
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 ICopyableChannel

Specified by:

createCopy in interface StandardGuildChannel

Specified by:

createCopy in interface StandardGuildMessageChannel

Returns:

A specific ChannelAction
This action allows to set fields for the new GuildChannel before creating it!

getManager

@Nonnull
@CheckReturnValue
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().

Specified by:

getManager in interface GuildChannel

Specified by:

getManager in interface ICategorizableChannel

Specified by:

getManager in interface IPermissionContainer

Specified by:

getManager in interface IPositionableChannel

Specified by:

getManager in interface ISlowmodeChannel

Specified by:

getManager in interface StandardGuildChannel

Specified by:

getManager in interface StandardGuildMessageChannel

Returns:

The ChannelManager of this GuildChannel

See Also:

• ChannelManager, for modifying fields each guild channel provides
• ChannelField, for all possible channel fields