Package net.dv8tion.jda.internal.entities.channel.concrete

Class CategoryImpl

java.lang.Object

net.dv8tion.jda.internal.entities.channel.AbstractChannelImpl<CategoryImpl>

net.dv8tion.jda.internal.entities.channel.middleman.AbstractGuildChannelImpl<CategoryImpl>

net.dv8tion.jda.internal.entities.channel.concrete.CategoryImpl

All Implemented Interfaces:

Comparable<GuildChannel>, Formattable, ICopyableChannel, IMemberContainer, IPermissionContainer, IPositionableChannel, Channel, Category, GuildChannel, ChannelUnion, GuildChannelUnion, IPermissionContainerUnion, IDetachableEntity, IMentionable, ISnowflake, IPermissionContainerMixin<CategoryImpl>, IPositionableChannelMixin<CategoryImpl>, ChannelMixin<CategoryImpl>, CategoryMixin<CategoryImpl>, GuildChannelMixin<CategoryImpl>, IDetachableEntityMixin

public class CategoryImpl
extends AbstractGuildChannelImpl<CategoryImpl>
implements Category, CategoryMixin<CategoryImpl>

Field Summary

Fields inherited from interface net.dv8tion.jda.api.entities.channel.Channel

MAX_NAME_LENGTH

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

JUMP_URL

Constructor Summary

Constructors

Constructor	Description
CategoryImpl(long id, GuildImpl guild)

Method Summary

Modifier and Type	Method	Description
ChannelAction<Category>	createCopy()	Creates a copy of the specified GuildChannel.
ChannelAction<ForumChannel>	createForumChannel(String name)	Creates a new ForumChannel with this Category as parent.
ChannelAction<MediaChannel>	createMediaChannel(String name)	Creates a new MediaChannel with this Category as parent.
ChannelAction<NewsChannel>	createNewsChannel(String name)	Creates a new NewsChannel with this Category as parent.
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.
GuildImpl	getGuild()	Returns the Guild that this GuildChannel is part of.
CategoryManager	getManager()	Returns the ChannelManager for this GuildChannel.
gnu.trove.map.TLongObjectMap<PermissionOverride>	getPermissionOverrideMap()
int	getPositionRaw()	The actual position of the GuildChannel as stored and given by Discord.
ChannelType	getType()	The ChannelType for this channel
boolean	isDetached()	Whether this entity is detached.
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.
CategoryImpl	setPosition(int position)

Methods inherited from class net.dv8tion.jda.internal.entities.channel.middleman.AbstractGuildChannelImpl

compareTo

Methods inherited from class net.dv8tion.jda.internal.entities.channel.AbstractChannelImpl

asAudioChannel, asCategory, asForumChannel, asGroupChannel, asGuildChannel, asGuildMessageChannel, asMediaChannel, asMessageChannel, asNewsChannel, asPrivateChannel, asStageChannel, asStandardGuildChannel, asStandardGuildMessageChannel, asTextChannel, asThreadChannel, asThreadContainer, asVoiceChannel, getIdLong, getJDA, getName, setName, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.entities.channel.concrete.Category

getChannels, getForumChannels, getMediaChannels, getMembers, getNewsChannels, getStageChannels, getTextChannels, getVoiceChannels

Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.concrete.CategoryMixin

createCopy

Methods inherited from interface net.dv8tion.jda.api.entities.channel.Channel

formatTo, getAsMention, getFlags, getJDA, getName

Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.ChannelMixin

delete, setName

Methods inherited from interface net.dv8tion.jda.api.entities.channel.unions.ChannelUnion

asAudioChannel, asCategory, asForumChannel, asGroupChannel, asGuildChannel, asGuildMessageChannel, asMediaChannel, asMessageChannel, asNewsChannel, asPrivateChannel, asStageChannel, asStandardGuildChannel, asStandardGuildMessageChannel, asTextChannel, asThreadChannel, asThreadContainer, asVoiceChannel

Methods inherited from interface java.lang.Comparable

compareTo

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

getJumpUrl

Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.middleman.GuildChannelMixin

checkCanAccess, checkCanManage, checkPermission, checkPermission, delete, hasPermission

Methods inherited from interface net.dv8tion.jda.api.entities.channel.unions.GuildChannelUnion

asAudioChannel, asCategory, asForumChannel, asGuildMessageChannel, asMediaChannel, asNewsChannel, asStageChannel, asStandardGuildChannel, asStandardGuildMessageChannel, asTextChannel, asThreadChannel, asThreadContainer, asVoiceChannel

Methods inherited from interface net.dv8tion.jda.internal.entities.detached.mixin.IDetachableEntityMixin

checkAttached, detachedException, detachedRequiresChannelException

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

getMemberPermissionOverrides, getRolePermissionOverrides

Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.attribute.IPermissionContainerMixin

getPermissionContainer, getPermissionOverride, getPermissionOverrides, upsertPermissionOverride

Methods inherited from interface net.dv8tion.jda.api.entities.channel.unions.IPermissionContainerUnion

asAudioChannel, asCategory, asForumChannel, asGuildMessageChannel, asNewsChannel, asStageChannel, asStandardGuildChannel, asStandardGuildMessageChannel, asTextChannel, asThreadContainer, asVoiceChannel

Methods inherited from interface net.dv8tion.jda.api.entities.channel.attribute.IPositionableChannel

getPosition

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

getId, getIdLong, getTimeCreated

Constructor Details

CategoryImpl

public CategoryImpl(long id,
 GuildImpl guild)

Method Details

isDetached

public boolean isDetached()

Description copied from interface: IDetachableEntity

Whether this entity is detached.

If this returns true, this entity cannot be retrieved, will never be updated, and most methods that would otherwise return a RestAction will throw a DetachedEntityException instead.

Specified by:

isDetached in interface IDetachableEntity

Returns:

True, if the entity is detached

getGuild

@Nonnull
public GuildImpl getGuild()

Description copied from interface: GuildChannel

Returns the Guild that this GuildChannel is part of.

Specified by:

getGuild in interface GuildChannel

Overrides:

getGuild in class AbstractGuildChannelImpl<CategoryImpl>

Returns:

Never-null Guild that this GuildChannel is part of.

getType

@Nonnull
public ChannelType getType()

Description copied from interface: Channel

The ChannelType for this channel

Specified by:

getType in interface Channel

Returns:

The channel type

getPositionRaw

public int getPositionRaw()

Description copied from interface: IPositionableChannel

The actual position of the GuildChannel as stored and given by Discord.

Channel positions are actually based on a pairing of the creation time (as stored in the snowflake id) and the position. If 2 or more channels share the same position then they are sorted based on their creation date. The more recent a channel was created, the lower it is in the hierarchy. This is handled by IPositionableChannel.getPosition() and it is most likely the method you want. If, for some reason, you want the actual position of the channel then this method will give you that value.

Specified by:

getPositionRaw in interface IPositionableChannel

Returns:

The true, Discord stored, position of the GuildChannel.

createTextChannel

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

Description copied from interface: Category

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

Specified by:

createTextChannel in interface Category

Parameters:

name - The name of the TextChannel to create (up to 100 characters)

Returns:

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

createNewsChannel

@Nonnull
public ChannelAction<NewsChannel> createNewsChannel(@Nonnull
 String name)

Description copied from interface: Category

Creates a new NewsChannel 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

Specified by:

createNewsChannel in interface Category

Parameters:

name - The name of the NewsChannel to create (up to 100 characters)

Returns:

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

createVoiceChannel

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

Description copied from interface: Category

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

Specified by:

createVoiceChannel in interface Category

Parameters:

name - The name of the VoiceChannel to create (up to 100 characters)

Returns:

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

createStageChannel

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

Description copied from interface: Category

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

Specified by:

createStageChannel in interface Category

Parameters:

name - The name of the StageChannel to create (up to 100 characters)

Returns:

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

createForumChannel

@Nonnull
public ChannelAction<ForumChannel> createForumChannel(@Nonnull
 String name)

Description copied from interface: Category

Creates a new ForumChannel 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

Specified by:

createForumChannel in interface Category

Parameters:

name - The name of the ForumChannel to create (up to 100 characters)

Returns:

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

createMediaChannel

@Nonnull
public ChannelAction<MediaChannel> createMediaChannel(@Nonnull
 String name)

Description copied from interface: Category

Creates a new MediaChannel 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

Specified by:

createMediaChannel in interface Category

Parameters:

name - The name of the MediaChannel to create (up to 100 characters)

Returns:

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

modifyTextChannelPositions

@Nonnull
public CategoryOrderAction modifyTextChannelPositions()

Description copied from interface: Category

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.

Specified by:

modifyTextChannelPositions in interface Category

Returns:

A CategoryOrderAction for ordering the Category's TextChannels and NewsChannels.

modifyVoiceChannelPositions

@Nonnull
public CategoryOrderAction modifyVoiceChannelPositions()

Description copied from interface: Category

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.

Specified by:

modifyVoiceChannelPositions in interface Category

Returns:

A CategoryOrderAction for ordering the Category's VoiceChannels and StageChannels.

createCopy

@Nonnull
public 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 Category

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

Specified by:

getManager in interface Category

Specified by:

getManager in interface GuildChannel

Specified by:

getManager in interface IPermissionContainer

Specified by:

getManager in interface IPositionableChannel

Returns:

The ChannelManager of this GuildChannel

getPermissionOverrideMap

public gnu.trove.map.TLongObjectMap<PermissionOverride> getPermissionOverrideMap()

Specified by:

getPermissionOverrideMap in interface IPermissionContainerMixin<CategoryImpl>

setPosition

public CategoryImpl setPosition(int position)

Specified by:

setPosition in interface IPositionableChannelMixin<CategoryImpl>