Package net.dv8tion.jda.api.entities

Interface Channel

All Superinterfaces:

Formattable, IMentionable, ISnowflake

All Known Subinterfaces:

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

public interface Channel
extends IMentionable

Abstract Channel interface for all ChannelTypes.

Method Summary

Modifier and Type	Method	Description
RestAction<Void>	delete()	TODO-v5: Revisit these docs Deletes this Channel.
default void	formatTo(Formatter formatter, int flags, int width, int precision)
default String	getAsMention()	Retrieve a Mention for this Entity.
JDA	getJDA()	Returns the JDA instance of this channel
String	getName()	The human readable name of this channel.
ChannelType	getType()	The ChannelType for this channel

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getIdLong, getTimeCreated

Method Details

getName

@Nonnull
String getName()

The human readable name of this channel.

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()

TODO-v5: Revisit these docs Deletes this Channel.

Possible ErrorResponses include:

• UNKNOWN_CHANNEL
  If this channel was already deleted

Returns:

RestAction

getAsMention

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