Interface GuildChannel
- All Superinterfaces:
Channel,Comparable<GuildChannel>,Formattable,IDetachableEntity,IMentionable,ISnowflake
- All Known Subinterfaces:
AudioChannel,AudioChannelUnion,Category,DefaultGuildChannelUnion,ForumChannel,GuildChannelUnion,GuildMessageChannel,GuildMessageChannelUnion,IAgeRestrictedChannel,ICategorizableChannel,ICopyableChannel,IInviteContainer,IMemberContainer,IPermissionContainer,IPermissionContainerUnion,IPositionableChannel,IPostContainer,ISlowmodeChannel,IThreadContainer,IThreadContainerUnion,IWebhookContainer,IWebhookContainerUnion,MediaChannel,NewsChannel,StageChannel,StandardGuildChannel,StandardGuildMessageChannel,TextChannel,ThreadChannel,VoiceChannel
Represents a
Guild channel.-
Field Summary
FieldsFields inherited from interface net.dv8tion.jda.api.entities.channel.Channel
MAX_NAME_LENGTH -
Method Summary
Modifier and TypeMethodDescriptiondelete()Deletes this GuildChannel.getGuild()Returns theGuildthat this GuildChannel is part of.default StringReturns the jump-to URL for this channel.ChannelManager<?,?> Returns theChannelManagerfor this GuildChannel.The channel containing the permissions relevant to this channel.Methods inherited from interface net.dv8tion.jda.api.entities.channel.Channel
formatTo, getAsMention, getFlags, getJDA, getName, getTypeMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface net.dv8tion.jda.api.entities.detached.IDetachableEntity
isDetachedMethods inherited from interface net.dv8tion.jda.api.entities.ISnowflake
getId, getIdLong, getTimeCreated
-
Field Details
-
JUMP_URL
Template forgetJumpUrl().- See Also:
-
-
Method Details
-
getGuild
Returns theGuildthat this GuildChannel is part of.- Returns:
- Never-null
Guildthat this GuildChannel is part of.
-
getManager
Returns theChannelManagerfor 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().- Returns:
- The ChannelManager of this GuildChannel
- Throws:
InsufficientPermissionException- If the currently logged in account does not havePermission.MANAGE_CHANNELDetachedEntityException- If this entity isdetached
-
delete
Deletes this GuildChannel.Possible ErrorResponses include:
UNKNOWN_CHANNEL
If this channel was already deletedMISSING_PERMISSIONS
The send request was attempted after the account lostPermission.MANAGE_CHANNELin the channel.MISSING_ACCESS
If we were removed from the Guild
- Specified by:
deletein interfaceChannel- Returns:
AuditableRestAction- Throws:
InsufficientPermissionException- if the currently logged in account doesn't haveMANAGE_CHANNELfor the channel.DetachedEntityException- If this entity isdetached
-
getPermissionContainer
The channel containing the permissions relevant to this channel.This is usually the same channel, but for threads the parent channel is used instead.
- Returns:
- The permission container
- Throws:
DetachedEntityException- If this entity isdetached
-
getJumpUrl
Returns the jump-to URL for this channel. Clicking this URL in the Discord client will cause the client to jump to the specified channel.- Returns:
- A String representing the jump-to URL for the channel.
-