Package net.dv8tion.jda.api.entities.channel.middleman

Interface StandardGuildMessageChannel

All Superinterfaces:

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

All Known Subinterfaces:

NewsChannel, TextChannel

public interface StandardGuildMessageChannel
extends StandardGuildChannel, GuildMessageChannel, IThreadContainer, IWebhookContainer, IAgeRestrictedChannel

Represents a standard GuildMessageChannel which are the "normal" message channels that are present in the channel sidebar. They include all the functionality of StandardGuildChannels along with the extra functionality expected of normal guild message channels like messaging, thread support, and webhooks.
These are not ThreadChannels.

See Also:

• GuildMessageChannel
• TextChannel
• NewsChannel
• StandardGuildChannel

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_TOPIC_LENGTH	The maximum length a channel topic can be (1024) Forum channels have a higher limit, defined by ForumChannel.MAX_FORUM_TOPIC_LENGTH

Fields inherited from interface net.dv8tion.jda.api.entities.channel.Channel

MAX_NAME_LENGTH

Fields inherited from interface net.dv8tion.jda.api.entities.channel.middleman.GuildChannel

JUMP_URL

Method Summary

Modifier and Type	Method	Description
ChannelAction<? extends StandardGuildMessageChannel>	createCopy()	Creates a copy of the specified GuildChannel.
ChannelAction<? extends StandardGuildMessageChannel>	createCopy(Guild guild)	Creates a copy of the specified GuildChannel in the specified Guild.
StandardGuildMessageChannelManager<?,?>	getManager()	Returns the ChannelManager for this GuildChannel.
String	getTopic()	The topic set for this channel.

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

formatTo, getAsMention, getFlags, getJDA, getName, getType

Methods inherited from interface java.lang.Comparable

compareTo

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

delete, getGuild, getJumpUrl, getPermissionContainer

Methods inherited from interface net.dv8tion.jda.api.entities.channel.middleman.GuildMessageChannel

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

Methods inherited from interface net.dv8tion.jda.api.entities.channel.attribute.IAgeRestrictedChannel

isNSFW

Methods inherited from interface net.dv8tion.jda.api.entities.channel.attribute.ICategorizableChannel

getParentCategory, getParentCategoryId, getParentCategoryIdLong, getPositionInCategory, isSynced

Methods inherited from interface net.dv8tion.jda.api.entities.detached.IDetachableEntity

isDetached

Methods inherited from interface net.dv8tion.jda.api.entities.channel.attribute.IInviteContainer

createInvite, retrieveInvites

Methods inherited from interface net.dv8tion.jda.api.entities.channel.attribute.IMemberContainer

getMembers

Methods inherited from interface net.dv8tion.jda.api.entities.channel.attribute.IPermissionContainer

getMemberPermissionOverrides, getPermissionOverride, getPermissionOverrides, getRolePermissionOverrides, upsertPermissionOverride

Methods inherited from interface net.dv8tion.jda.api.entities.channel.attribute.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.channel.attribute.IThreadContainer

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

Methods inherited from interface net.dv8tion.jda.api.entities.channel.attribute.IWebhookContainer

createWebhook, deleteWebhookById, retrieveWebhooks

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

addReactionById, addReactionById, deleteMessageById, deleteMessageById, editMessageAttachmentsById, editMessageAttachmentsById, editMessageAttachmentsById, editMessageAttachmentsById, editMessageById, editMessageById, editMessageById, editMessageById, 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, sendMessageEmbeds, sendMessageEmbeds, sendMessageFormat, sendMessagePoll, sendTyping, unpinMessageById, unpinMessageById

Field Details

MAX_TOPIC_LENGTH

static final int MAX_TOPIC_LENGTH

The maximum length a channel topic can be (1024)
Forum channels have a higher limit, defined by ForumChannel.MAX_FORUM_TOPIC_LENGTH

See Also:

• Constant Field Values

Method Details

getManager

@Nonnull
@CheckReturnValue
StandardGuildMessageChannelManager<?,?> 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 StandardGuildChannel

Returns:

The ChannelManager of this GuildChannel

getTopic

@Nullable
String getTopic()

The topic set for this channel.
If no topic has been set, this returns null.

Returns:

Possibly-null String containing the topic of this channel.

createCopy

@Nonnull
@CheckReturnValue
ChannelAction<? extends StandardGuildMessageChannel> 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

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
ChannelAction<? extends StandardGuildMessageChannel> 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

Returns:

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