Interface Channel

All Superinterfaces:

Formattable, IDetachableEntity, IMentionable, ISnowflake

All Known Subinterfaces:

AudioChannel, AudioChannelUnion, Category, ChannelUnion, DefaultGuildChannelUnion, ForumChannel, GroupChannel, GuildChannel, GuildChannelUnion, GuildMessageChannel, GuildMessageChannelUnion, IAgeRestrictedChannel, ICategorizableChannel, ICopyableChannel, IInviteContainer, IMemberContainer, IPermissionContainer, IPermissionContainerUnion, IPositionableChannel, IPostContainer, ISlowmodeChannel, ISoundboardSoundChannel, IThreadContainer, IThreadContainerUnion, IVoiceStatusChannel, IWebhookContainer, IWebhookContainerUnion, MediaChannel, MessageChannel, MessageChannelUnion, NewsChannel, PrivateChannel, StageChannel, StandardGuildChannel, StandardGuildMessageChannel, TextChannel, ThreadChannel, VoiceChannel

public interface Channel
extends IMentionable, IDetachableEntity

Abstract Channel interface for all ChannelTypes.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_NAME_LENGTH	The maximum length a channel name can be.

Method Summary

Modifier and Type	Method	Description
RestAction<Void>	delete()	Deletes this Channel.
default void	formatTo(Formatter formatter, int flags, int width, int precision)
default String	getAsMention()	Retrieve a Mention for this Entity.
EnumSet<ChannelFlag>	getFlags()	The flags configured for this channel.
long	getFlagsRaw()	The raw channel flags available for this channel.
JDA	getJDA()	Returns the JDA instance of this channel
String	getJumpUrl()	Returns the jump-to URL for this channel.
String	getName()	The human readable name of this channel.
ChannelType	getType()	The ChannelType for this channel
default boolean	isObfuscated()	Whether this channel is obfuscated.

Methods inherited from interface IDetachableEntity

isDetached

Methods inherited from interface ISnowflake

getId, getIdLong, getTimeCreated

Field Details

MAX_NAME_LENGTH

static final int MAX_NAME_LENGTH

The maximum length a channel name can be. (100)

See Also:

• Constant Field Values

Method Details

getFlags

@Nonnull
EnumSet<ChannelFlag> getFlags()

The flags configured for this channel.
This feature is currently primarily used for ForumChannels.

Returns:

EnumSet of the configured ChannelFlags, changes to this enum set are not reflected in the API.

getFlagsRaw

long getFlagsRaw()

The raw channel flags available for this channel.

For obfuscated channels this will always be ChannelFlag.OBFUSCATED (1 << 17).

Returns:

The raw flags for this channel

See Also:

• getFlags()

isObfuscated

default boolean isObfuscated()

Whether this channel is obfuscated.

An obfuscated channel is inaccessible to the logged-in account. It does not provide anything besides positional information. Methods like getName() will not return the actual name of the channel.

Note that channels in interactions are never obfuscated and will instead be detached channels when the channel is otherwise inaccessible.

Returns:

True, if this channel is obfuscated.

getName

@Nonnull
String getName()

The human readable name of this channel.

May be an empty string for GroupChannels with no name (Group DMs with no name displays the recipients on the Discord client).

Returns:

The name of this channel

getType

@Nonnull
ChannelType getType()

The ChannelType for this channel

Returns:

The channel type

getJDA

@Nonnull
JDA getJDA()

Returns the JDA instance of this channel

Returns:

the corresponding JDA instance

delete

@Nonnull
@CheckReturnValue
RestAction<Void> delete()

Deletes this Channel.

Possible ErrorResponses include:

• UNKNOWN_CHANNEL
  If this channel was already deleted

Returns:

RestAction

getJumpUrl

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

getAsMention

@Nonnull
default String getAsMention()

Description copied from interface: IMentionable

Retrieve a Mention for this Entity. For the public Role (@everyone), this will return the literal string "@everyone".

Specified by:

getAsMention in interface IMentionable

Returns:

A resolvable mention.

formatTo

default void formatTo(Formatter formatter,
 int flags,
 int width,
 int precision)

Specified by:

formatTo in interface Formattable

Specified by:

formatTo in interface IMentionable