Package net.dv8tion.jda.api.entities

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.

Since:

3.4.0

See Also:

• Guild.getCategoryCache()
• IGuildChannelContainer.getCategories()
• IGuildChannelContainer.getCategoriesByName(String, boolean)
• IGuildChannelContainer.getCategoryById(long)
• IGuildChannelContainer.getCategoryCache()
• IGuildChannelContainer.getCategories()
• IGuildChannelContainer.getCategoriesByName(String, boolean)
• IGuildChannelContainer.getCategoryById(long)

Field Summary

Fields inherited from interface net.dv8tion.jda.api.entities.GuildChannel

JUMP_URL

Method Summary

Modifier and Type	Method	Description
ChannelAction<Category>	createCopy()	Creates a copy of the specified GuildChannel.
ChannelAction<Category>	createCopy(Guild guild)	Creates a copy of the specified GuildChannel in the specified Guild.
ChannelAction<StageChannel>	createStageChannel(String name)	Creates a new StageChannel with this Category as parent.
ChannelAction<TextChannel>	createTextChannel(String name)	Creates a new TextChannel with this Category as parent.
ChannelAction<VoiceChannel>	createVoiceChannel(String name)	Creates a new VoiceChannel with this Category as parent.
default List<GuildChannel>	getChannels()	All Channels listed for this Category This may contain VoiceChannels, and TextChannels!
CategoryManager	getManager()	Returns the ChannelManager for this GuildChannel.
default List<Member>	getMembers()	A List of all Members that are in this GuildChannel For TextChannels, this returns all Members with the Permission.VIEW_CHANNEL Permission.
default List<NewsChannel>	getNewsChannels()	All NewsChannels listed for this Category
default List<StageChannel>	getStageChannels()	All StageChannel listed for this Category
default List<TextChannel>	getTextChannels()	All TextChannels listed for this Category
default List<VoiceChannel>	getVoiceChannels()	All VoiceChannels listed for this Category
CategoryOrderAction	modifyTextChannelPositions()	Modifies the positional order of this Category's nested TextChannels and NewsChannels.
CategoryOrderAction	modifyVoiceChannelPositions()	Modifies the positional order of this Category's nested VoiceChannels and StageChannels.

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, getJumpUrl, getPermissionContainer

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

getMemberPermissionOverrides, getPermissionOverride, getPermissionOverrides, getRolePermissionOverrides, 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 Details

getChannels

@Nonnull
default List<GuildChannel> getChannels()

All Channels listed for this Category
This may contain VoiceChannels, and TextChannels!

Returns:

Immutable list of all child channels

getTextChannels

@Nonnull
default List<TextChannel> getTextChannels()

All TextChannels listed for this Category

Returns:

Immutable list of all child TextChannels

getNewsChannels

@Nonnull
default List<NewsChannel> getNewsChannels()

All NewsChannels listed for this Category

Returns:

Immutable list of all child NewsChannels

getVoiceChannels

@Nonnull
default List<VoiceChannel> getVoiceChannels()

All VoiceChannels listed for this Category

Returns:

Immutable list of all child VoiceChannels

getStageChannels

@Nonnull
default List<StageChannel> getStageChannels()

All StageChannel listed for this Category

Returns:

Immutable list of all child StageChannel

createTextChannel

@Nonnull
@CheckReturnValue
ChannelAction<TextChannel> createTextChannel(@Nonnull
 String name)

Creates a new TextChannel with this Category as parent. For this to be successful, the logged in account has to have the MANAGE_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. See IPermissionHolder.canSync(IPermissionContainer, IPermissionContainer) for details.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MISSING_ACCESS
  The VIEW_CHANNEL permission was removed
• MAX_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 the Permission.MANAGE_CHANNEL permission

IllegalArgumentException - If the provided name is null or empty or greater than 100 characters in length

createVoiceChannel

@Nonnull
@CheckReturnValue
ChannelAction<VoiceChannel> createVoiceChannel(@Nonnull
 String name)

Creates a new VoiceChannel with this Category as parent. For this to be successful, the logged in account has to have the MANAGE_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. See IPermissionHolder.canSync(IPermissionContainer, IPermissionContainer) for details.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MISSING_ACCESS
  The VIEW_CHANNEL permission was removed
• MAX_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 the Permission.MANAGE_CHANNEL permission

IllegalArgumentException - If the provided name is null or empty or greater than 100 characters in length

createStageChannel

@Nonnull
@CheckReturnValue
ChannelAction<StageChannel> createStageChannel(@Nonnull
 String name)

Creates a new StageChannel with this Category as parent. For this to be successful, the logged in account has to have the MANAGE_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. See IPermissionHolder.canSync(IPermissionContainer, IPermissionContainer) for details.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MISSING_ACCESS
  The VIEW_CHANNEL permission was removed
• MAX_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 the Permission.MANAGE_CHANNEL permission

IllegalArgumentException - If the provided name is null or empty or greater than 100 characters in length

modifyTextChannelPositions

@Nonnull
@CheckReturnValue
CategoryOrderAction modifyTextChannelPositions()

Modifies the positional order of this Category's nested TextChannels and NewsChannels.
This uses an extension of ChannelOrderAction specialized for ordering the nested TextChannels and NewsChannels of this Category.
Like ChannelOrderAction, the returned CategoryOrderAction can be used to move TextChannels/NewsChannels up, down, or to 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's TextChannels and NewsChannels.

modifyVoiceChannelPositions

@Nonnull
@CheckReturnValue
CategoryOrderAction modifyVoiceChannelPositions()

Modifies the positional order of this Category's nested VoiceChannels and StageChannels.
This uses an extension of ChannelOrderAction specialized for ordering the nested VoiceChannels and StageChannels of this Category.
Like ChannelOrderAction, the returned CategoryOrderAction can be used to move VoiceChannels/StageChannels up, down, or to 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's VoiceChannels and StageChannels.

getMembers

@Nonnull
default List<Member> getMembers()

Description copied from interface: IMemberContainer

A List of all Members that are in this GuildChannel
For TextChannels, this returns all Members with the Permission.VIEW_CHANNEL Permission.
For VoiceChannels, this returns all Members that joined that VoiceChannel.
For Categories, this returns all Members who are in its child channels.

Specified by:

getMembers in interface IMemberContainer

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 specified GuildChannel in the specified Guild.
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:

1. Name
2. Parent Category (if present)
3. Voice Elements (Bitrate, Userlimit)
4. Text Elements (Topic, NSFW, Slowmode)
5. All permission overrides for Members/Roles

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MISSING_ACCESS
  The VIEW_CHANNEL permission was removed

Specified by:

createCopy in interface ICopyableChannel

Parameters:

guild - The Guild 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 specified GuildChannel.

This copies the following elements:

1. Name
2. Parent Category (if present)
3. Voice Elements (Bitrate, Userlimit)
4. Text Elements (Topic, NSFW, Slowmode)
5. All permission overrides for Members/Roles

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MISSING_ACCESS
  The VIEW_CHANNEL permission was removed

Specified by:

createCopy in interface ICopyableChannel

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

Specified by:

getManager in interface GuildChannel

Specified by:

getManager in interface IPermissionContainer

Specified by:

getManager in interface IPositionableChannel

Returns:

The ChannelManager of this GuildChannel