Package net.dv8tion.jda.api.entities

Interface Category

All Superinterfaces:

AbstractChannel, java.lang.Comparable<GuildChannel>, java.util.Formattable, GuildChannel, IMentionable, ISnowflake

public interface Category
extends GuildChannel

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(), Guild.getCategories(), Guild.getCategoriesByName(String, boolean), Guild.getCategoryById(long), JDA.getCategoryCache(), JDA.getCategories(), JDA.getCategoriesByName(String, boolean), JDA.getCategoryById(long)

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(java.lang.String name)	Creates a new StageChannel with this Category as parent.
ChannelAction<TextChannel>	createTextChannel(java.lang.String name)	Creates a new TextChannel with this Category as parent.
ChannelAction<VoiceChannel>	createVoiceChannel(java.lang.String name)	Creates a new VoiceChannel with this Category as parent.
java.util.List<GuildChannel>	getChannels()	All Channels listed for this Category This may contain VoiceChannels, StoreChannels, and TextChannels!
java.util.List<StoreChannel>	getStoreChannels()	All StoreChannels listed for this Category
java.util.List<TextChannel>	getTextChannels()	All TextChannels listed for this Category
java.util.List<VoiceChannel>	getVoiceChannels()	All VoiceChannels listed for this Category
CategoryOrderAction	modifyTextChannelPositions()	Modifies the positional order of this Category's nested TextChannels and StoreChannels.
CategoryOrderAction	modifyVoiceChannelPositions()	Modifies the positional order of this Category's nested VoiceChannels.

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

getJDA, getName, getType

Methods inherited from interface java.lang.Comparable

compareTo

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

createInvite, createPermissionOverride, delete, getGuild, getManager, getMemberPermissionOverrides, getMembers, getParent, getPermissionOverride, getPermissionOverrides, getPosition, getPositionRaw, getRolePermissionOverrides, isSynced, putPermissionOverride, retrieveInvites, upsertPermissionOverride

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

formatTo, getAsMention

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

getId, getIdLong, getTimeCreated

Method Detail

getChannels

@Nonnull
java.util.List<GuildChannel> getChannels()

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

Returns:

Immutable list of all child channels

getStoreChannels

@Nonnull
java.util.List<StoreChannel> getStoreChannels()

All StoreChannels listed for this Category

Returns:

Immutable list of all child StoreChannels

Since:

4.0.0

getTextChannels

@Nonnull
java.util.List<TextChannel> getTextChannels()

All TextChannels listed for this Category

Returns:

Immutable list of all child TextChannels

getVoiceChannels

@Nonnull
java.util.List<VoiceChannel> getVoiceChannels()

All VoiceChannels listed for this Category

Returns:

Immutable list of all child VoiceChannels

createTextChannel

@Nonnull
@CheckReturnValue
ChannelAction<TextChannel> createTextChannel(@Nonnull
                                             java.lang.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(GuildChannel, GuildChannel) 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

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

createVoiceChannel

@Nonnull
@CheckReturnValue
ChannelAction<VoiceChannel> createVoiceChannel(@Nonnull
                                               java.lang.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(GuildChannel, GuildChannel) 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

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

createStageChannel

@Nonnull
@CheckReturnValue
ChannelAction<StageChannel> createStageChannel(@Nonnull
                                               java.lang.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(GuildChannel, GuildChannel) 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

java.lang.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 StoreChannels.
This uses an extension of ChannelOrderAction specialized for ordering the nested TextChannels and StoreChannels of this Category.
Like ChannelOrderAction, the returned CategoryOrderAction can be used to move TextChannels/StoreChannels 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 StoreChannels.

modifyVoiceChannelPositions

@Nonnull
@CheckReturnValue
CategoryOrderAction modifyVoiceChannelPositions()

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

createCopy

@Nonnull
ChannelAction<Category> createCopy(@Nonnull
                                   Guild guild)

Description copied from interface: GuildChannel

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 GuildChannel

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: GuildChannel

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 GuildChannel

Returns:

A specific ChannelAction
This action allows to set fields for the new GuildChannel before creating it!