Package net.dv8tion.jda.api.entities
Interface Channel
-
- All Superinterfaces:
Formattable
,IMentionable
,ISnowflake
- All Known Subinterfaces:
AudioChannel
,BaseGuildMessageChannel
,Category
,GuildChannel
,GuildMessageChannel
,ICategorizableChannel
,ICopyableChannel
,IInviteContainer
,IMemberContainer
,IPermissionContainer
,IPositionableChannel
,IThreadContainer
,MessageChannel
,NewsChannel
,PrivateChannel
,StageChannel
,StoreChannel
,TextChannel
,ThreadChannel
,VoiceChannel
public interface Channel extends IMentionable
Abstract Channel interface for allChannelTypes
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods 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 theJDA
instance of this channelString
getName()
The human readable name of this channel.ChannelType
getType()
TheChannelType
for this channel-
Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake
getId, getIdLong, getTimeCreated
-
-
-
-
Method Detail
-
getName
@Nonnull String getName()
The human readable name of this channel.- Returns:
- The name of this channel
-
getType
@Nonnull ChannelType getType()
TheChannelType
for this channel- Returns:
- The channel type
-
getJDA
@Nonnull JDA getJDA()
Returns theJDA
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 publicRole
(@everyone), this will return the literal string"@everyone"
.- Specified by:
getAsMention
in interfaceIMentionable
- Returns:
- A resolvable mention.
-
formatTo
default void formatTo(Formatter formatter, int flags, int width, int precision)
- Specified by:
formatTo
in interfaceFormattable
- Specified by:
formatTo
in interfaceIMentionable
-
-