Package net.dv8tion.jda.api.entities

Interface GuildChannel

All Superinterfaces:

Channel, Comparable<GuildChannel>, Formattable, IMentionable, ISnowflake

All Known Subinterfaces:

AudioChannel, Category, DefaultGuildChannelUnion, GuildChannelUnion, GuildMessageChannel, GuildMessageChannelUnion, IAgeRestrictedChannel, ICategorizableChannel, ICopyableChannel, IInviteContainer, IMemberContainer, IPermissionContainer, IPermissionContainerUnion, IPositionableChannel, IThreadContainer, IThreadContainerUnion, IWebhookContainer, IWebhookContainerUnion, NewsChannel, StageChannel, StandardGuildChannel, StandardGuildMessageChannel, TextChannel, ThreadChannel, VoiceChannel

public interface GuildChannel
extends Channel, Comparable<GuildChannel>

Represents a Guild channel.

See Also:

• IGuildChannelContainer.getGuildChannelById(long)
• IGuildChannelContainer.getGuildChannelById(ChannelType, long)
• IGuildChannelContainer.getGuildChannelById(long)
• IGuildChannelContainer.getGuildChannelById(ChannelType, long)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JUMP_URL	Template for getJumpUrl().

Method Summary

Modifier and Type	Method	Description
AuditableRestAction<Void>	delete()	TODO-v5: this override might not be needed anymore if we remove AuditableRestAction and instead place auditable hooks onto RestAction itself.
Guild	getGuild()	Returns the Guild that this GuildChannel is part of.
default String	getJumpUrl()	Returns the jump-to URL for this channel.
ChannelManager<?,?>	getManager()	Returns the ChannelManager for this GuildChannel.
IPermissionContainer	getPermissionContainer()

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.ISnowflake

getId, getIdLong, getTimeCreated

Field Details

JUMP_URL

static final String JUMP_URL

Template for getJumpUrl().

See Also:

• Constant Field Values

Method Details

getGuild

@Nonnull
Guild getGuild()

Returns the Guild that this GuildChannel is part of.

Returns:

Never-null Guild that this GuildChannel is part of.

getManager

@Nonnull
ChannelManager<?,?> getManager()

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.

Returns:

The ChannelManager of this GuildChannel

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_CHANNEL

delete

@Nonnull
@CheckReturnValue
AuditableRestAction<Void> delete()

TODO-v5: this override might not be needed anymore if we remove AuditableRestAction and instead place auditable hooks onto RestAction itself. Deletes this GuildChannel.

Possible ErrorResponses include:

• UNKNOWN_CHANNEL
  If this channel was already deleted
• MISSING_PERMISSIONS
  The send request was attempted after the account lost Permission.MANAGE_CHANNEL in the channel.
• MISSING_ACCESS
  If we were removed from the Guild

Specified by:

delete in interface Channel

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - if the currently logged in account doesn't have MANAGE_CHANNEL for the channel.

getPermissionContainer

IPermissionContainer getPermissionContainer()

getJumpUrl

@Nonnull
default String 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.