Interface Category
-
- All Superinterfaces:
Channel
,Comparable<GuildChannel>
,Formattable
,GuildChannel
,ICopyableChannel
,IMemberContainer
,IMentionable
,IPermissionContainer
,IPositionableChannel
,ISnowflake
public interface Category extends GuildChannel, ICopyableChannel, IPositionableChannel, IPermissionContainer, IMemberContainer
Represents a channel category in the official Discord API.
Categories are used to keep order in a Guild by dividing the channels into groups.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description ChannelAction<Category>
createCopy()
Creates a copy of the specifiedGuildChannel
.ChannelAction<Category>
createCopy(Guild guild)
Creates a copy of the specifiedGuildChannel
in the specifiedGuild
.ChannelAction<StageChannel>
createStageChannel(String name)
Creates a newStageChannel
with this Category as parent.ChannelAction<TextChannel>
createTextChannel(String name)
Creates a newTextChannel
with this Category as parent.ChannelAction<VoiceChannel>
createVoiceChannel(String name)
Creates a newVoiceChannel
with this Category as parent.default List<GuildChannel>
getChannels()
AllChannels
listed for this Category
This may containVoiceChannels
,StoreChannels
, andTextChannels
!CategoryManager
getManager()
Returns theChannelManager
for this GuildChannel.default List<Member>
getMembers()
A List of allMembers
that are in this GuildChannel
ForTextChannels
, this returns all Members with thePermission.VIEW_CHANNEL
Permission.default List<NewsChannel>
getNewsChannels()
AllNewsChannels
listed for this Categorydefault List<StageChannel>
getStageChannels()
AllStageChannel
listed for this Categorydefault List<StoreChannel>
getStoreChannels()
AllStoreChannels
listed for this Categorydefault List<TextChannel>
getTextChannels()
AllTextChannels
listed for this Categorydefault List<VoiceChannel>
getVoiceChannels()
AllVoiceChannels
listed for this CategoryCategoryOrderAction
modifyTextChannelPositions()
Modifies the positional order of this Category's nestedTextChannels
andStoreChannels
.CategoryOrderAction
modifyVoiceChannelPositions()
Modifies the positional order of this Category's nestedVoiceChannels
.-
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.GuildChannel
delete, getGuild, getPermissionContainer
-
Methods inherited from interface net.dv8tion.jda.api.entities.IPermissionContainer
createPermissionOverride, getMemberPermissionOverrides, getPermissionOverride, getPermissionOverrides, getRolePermissionOverrides, putPermissionOverride, upsertPermissionOverride
-
Methods inherited from interface net.dv8tion.jda.api.entities.IPositionableChannel
getPosition, getPositionRaw
-
Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake
getId, getIdLong, getTimeCreated
-
-
-
-
Method Detail
-
getChannels
@Nonnull default List<GuildChannel> getChannels()
AllChannels
listed for this Category
This may containVoiceChannels
,StoreChannels
, andTextChannels
!- Returns:
- Immutable list of all child channels
-
getStoreChannels
@Nonnull default List<StoreChannel> getStoreChannels()
AllStoreChannels
listed for this Category- Returns:
- Immutable list of all child StoreChannels
- Since:
- 4.0.0
-
getTextChannels
@Nonnull default List<TextChannel> getTextChannels()
AllTextChannels
listed for this Category- Returns:
- Immutable list of all child TextChannels
-
getNewsChannels
@Nonnull default List<NewsChannel> getNewsChannels()
AllNewsChannels
listed for this Category- Returns:
- Immutable list of all child NewsChannels
-
getVoiceChannels
@Nonnull default List<VoiceChannel> getVoiceChannels()
AllVoiceChannels
listed for this Category- Returns:
- Immutable list of all child VoiceChannels
-
getStageChannels
@Nonnull default List<StageChannel> getStageChannels()
AllStageChannel
listed for this Category- Returns:
- Immutable list of all child StageChannel
-
createTextChannel
@Nonnull @CheckReturnValue ChannelAction<TextChannel> createTextChannel(@Nonnull String name)
Creates a newTextChannel
with this Category as parent. For this to be successful, the logged in account has to have theMANAGE_CHANNEL
Permission in this Category.This will copy all
PermissionOverrides
of this Category! Unless the bot is unable to sync it with this category due to permission escalation. SeeIPermissionHolder.canSync(IPermissionContainer, IPermissionContainer)
for details.Possible
ErrorResponses
caused by the returnedRestAction
include the following:MISSING_PERMISSIONS
The channel could not be created due to a permission discrepancyMISSING_ACCESS
TheVIEW_CHANNEL
permission was removedMAX_CHANNELS
The maximum number of channels were exceeded
- Parameters:
name
- The name of the TextChannel to create- Returns:
- A specific
ChannelAction
This action allows to set fields for the new TextChannel before creating it - Throws:
InsufficientPermissionException
- If the logged in account does not have thePermission.MANAGE_CHANNEL
permissionIllegalArgumentException
- If the provided name isnull
or empty or greater than 100 characters in length
-
createVoiceChannel
@Nonnull @CheckReturnValue ChannelAction<VoiceChannel> createVoiceChannel(@Nonnull String name)
Creates a newVoiceChannel
with this Category as parent. For this to be successful, the logged in account has to have theMANAGE_CHANNEL
Permission in this Category.This will copy all
PermissionOverrides
of this Category! Unless the bot is unable to sync it with this category due to permission escalation. SeeIPermissionHolder.canSync(IPermissionContainer, IPermissionContainer)
for details.Possible
ErrorResponses
caused by the returnedRestAction
include the following:MISSING_PERMISSIONS
The channel could not be created due to a permission discrepancyMISSING_ACCESS
TheVIEW_CHANNEL
permission was removedMAX_CHANNELS
The maximum number of channels were exceeded
- Parameters:
name
- The name of the VoiceChannel to create- Returns:
- A specific
ChannelAction
This action allows to set fields for the new VoiceChannel before creating it - Throws:
InsufficientPermissionException
- If the logged in account does not have thePermission.MANAGE_CHANNEL
permissionIllegalArgumentException
- If the provided name isnull
or empty or greater than 100 characters in length
-
createStageChannel
@Nonnull @CheckReturnValue ChannelAction<StageChannel> createStageChannel(@Nonnull String name)
Creates a newStageChannel
with this Category as parent. For this to be successful, the logged in account has to have theMANAGE_CHANNEL
Permission in this Category.This will copy all
PermissionOverrides
of this Category! Unless the bot is unable to sync it with this category due to permission escalation. SeeIPermissionHolder.canSync(IPermissionContainer, IPermissionContainer)
for details.Possible
ErrorResponses
caused by the returnedRestAction
include the following:MISSING_PERMISSIONS
The channel could not be created due to a permission discrepancyMISSING_ACCESS
TheVIEW_CHANNEL
permission was removedMAX_CHANNELS
The maximum number of channels were exceeded
- Parameters:
name
- The name of the StageChannel to create- Returns:
- A specific
ChannelAction
This action allows to set fields for the new StageChannel before creating it - Throws:
InsufficientPermissionException
- If the logged in account does not have thePermission.MANAGE_CHANNEL
permissionIllegalArgumentException
- If the provided name isnull
or empty or greater than 100 characters in length
-
modifyTextChannelPositions
@Nonnull @CheckReturnValue CategoryOrderAction modifyTextChannelPositions()
Modifies the positional order of this Category's nestedTextChannels
andStoreChannels
.
This uses an extension ofChannelOrderAction
specialized for ordering the nestedTextChannels
andStoreChannels
of thisCategory
.
LikeChannelOrderAction
, the returnedCategoryOrderAction
can be used to move TextChannels/StoreChannelsup
,down
, orto
a specific position.
This uses ascending order with a 0 based index.Possible
ErrorResponses
include:UNNKOWN_CHANNEL
One of the channels has been deleted before the completion of the task.MISSING_ACCESS
The currently logged in account was removed from the Guild.
- Returns:
- A
CategoryOrderAction
for ordering the Category'sTextChannels
andStoreChannels
.
-
modifyVoiceChannelPositions
@Nonnull @CheckReturnValue CategoryOrderAction modifyVoiceChannelPositions()
Modifies the positional order of this Category's nestedVoiceChannels
.
This uses an extension ofChannelOrderAction
specialized for ordering the nestedVoiceChannels
of thisCategory
.
LikeChannelOrderAction
, the returnedCategoryOrderAction
can be used to move VoiceChannelsup
,down
, orto
a specific position.
This uses ascending order with a 0 based index.Possible
ErrorResponses
include:UNNKOWN_CHANNEL
One of the channels has been deleted before the completion of the task.MISSING_ACCESS
The currently logged in account was removed from the Guild.
- Returns:
- A
CategoryOrderAction
for ordering the Category'sVoiceChannels
.
-
getMembers
@Nonnull default List<Member> getMembers()
Description copied from interface:IMemberContainer
A List of allMembers
that are in this GuildChannel
ForTextChannels
, this returns all Members with thePermission.VIEW_CHANNEL
Permission.
ForVoiceChannels
, this returns all Members that joined that VoiceChannel.
ForCategories
, this returns all Members who are in its child channels.- Specified by:
getMembers
in interfaceIMemberContainer
- Returns:
- An immutable List of
Members
that are in this GuildChannel.
-
createCopy
@Nonnull ChannelAction<Category> createCopy(@Nonnull Guild guild)
Description copied from interface:ICopyableChannel
Creates a copy of the specifiedGuildChannel
in the specifiedGuild
.
If the provided target guild is not the same Guild this channel is in then the parent category and permissions will not be copied due to technical difficulty and ambiguity.This copies the following elements:
- Name
- Parent Category (if present)
- Voice Elements (Bitrate, Userlimit)
- Text Elements (Topic, NSFW, Slowmode)
- All permission overrides for Members/Roles
Possible
ErrorResponses
caused by the returnedRestAction
include the following:MISSING_PERMISSIONS
The channel could not be created due to a permission discrepancyMISSING_ACCESS
TheVIEW_CHANNEL
permission was removed
- Specified by:
createCopy
in interfaceICopyableChannel
- Parameters:
guild
- TheGuild
to create the channel in- Returns:
- A specific
ChannelAction
This action allows to set fields for the new GuildChannel before creating it!
-
createCopy
@Nonnull ChannelAction<Category> createCopy()
Description copied from interface:ICopyableChannel
Creates a copy of the specifiedGuildChannel
.This copies the following elements:
- Name
- Parent Category (if present)
- Voice Elements (Bitrate, Userlimit)
- Text Elements (Topic, NSFW, Slowmode)
- All permission overrides for Members/Roles
Possible
ErrorResponses
caused by the returnedRestAction
include the following:MISSING_PERMISSIONS
The channel could not be created due to a permission discrepancyMISSING_ACCESS
TheVIEW_CHANNEL
permission was removed
- Specified by:
createCopy
in interfaceICopyableChannel
- Returns:
- A specific
ChannelAction
This action allows to set fields for the new GuildChannel before creating it!
-
getManager
@Nonnull CategoryManager getManager()
Description copied from interface:GuildChannel
Returns theChannelManager
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 callingRestAction.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.
- Specified by:
getManager
in interfaceGuildChannel
- Specified by:
getManager
in interfaceIPermissionContainer
- Specified by:
getManager
in interfaceIPositionableChannel
- Returns:
- The ChannelManager of this GuildChannel
-
-