Interface CategoryMixin<T extends CategoryMixin<T>>
- All Superinterfaces:
Category
,Channel
,ChannelMixin<T>
,ChannelUnion
,Comparable<GuildChannel>
,Formattable
,GuildChannel
,GuildChannelMixin<T>
,GuildChannelUnion
,ICopyableChannel
,IDetachableEntity
,IDetachableEntityMixin
,IMemberContainer
,IMentionable
,IPermissionContainer
,IPermissionContainerMixin<T>
,IPermissionContainerUnion
,IPositionableChannel
,IPositionableChannelMixin<T>
,ISnowflake
- All Known Implementing Classes:
CategoryImpl
,DetachedCategoryImpl
public interface CategoryMixin<T extends CategoryMixin<T>>
extends Category, IPositionableChannelMixin<T>, IPermissionContainerMixin<T>
-
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
-
Method Summary
Modifier and TypeMethodDescriptiondefault ChannelAction
<Category> createCopy
(Guild guild) Creates a copy of the specifiedGuildChannel
in the specifiedGuild
.Methods inherited from interface net.dv8tion.jda.api.entities.channel.concrete.Category
createCopy, createForumChannel, createMediaChannel, createNewsChannel, createStageChannel, createTextChannel, createVoiceChannel, getChannels, getForumChannels, getManager, getMediaChannels, getMembers, getNewsChannels, getStageChannels, getTextChannels, getVoiceChannels, modifyTextChannelPositions, modifyVoiceChannelPositions
Methods inherited from interface net.dv8tion.jda.api.entities.channel.Channel
formatTo, getAsMention, getFlags, getJDA, getName, getType
Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.ChannelMixin
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
getGuild, 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.api.entities.detached.IDetachableEntity
isDetached
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
getManager, getMemberPermissionOverrides, getRolePermissionOverrides
Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.attribute.IPermissionContainerMixin
getPermissionContainer, getPermissionOverride, getPermissionOverrideMap, 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, getPositionRaw
Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.attribute.IPositionableChannelMixin
setPosition
Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake
getId, getIdLong, getTimeCreated
-
Method Details
-
createCopy
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 interfaceCategory
- 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!
-