Package net.dv8tion.jda.internal.entities.channel.mixin.attribute

Interface IPermissionContainerMixin<T extends IPermissionContainerMixin<T>>

All Superinterfaces:

Channel, ChannelMixin<T>, ChannelUnion, Comparable<GuildChannel>, Formattable, GuildChannel, GuildChannelMixin<T>, GuildChannelUnion, IDetachableEntity, IDetachableEntityMixin, IMentionable, IPermissionContainer, IPermissionContainerUnion, ISnowflake

All Known Subinterfaces:

AudioChannelMixin<T>, CategoryMixin<T>, ForumChannelMixin<T>, ICategorizableChannelMixin<T>, MediaChannelMixin<T>, NewsChannelMixin<T>, StageChannelMixin<T>, StandardGuildChannelMixin<T>, StandardGuildMessageChannelMixin<T>, TextChannelMixin<T>, VoiceChannelMixin<T>

All Known Implementing Classes:

AbstractStandardGuildChannelImpl, AbstractStandardGuildMessageChannelImpl, CategoryImpl, DetachedCategoryImpl, DetachedForumChannelImpl, DetachedMediaChannelImpl, DetachedNewsChannelImpl, DetachedStageChannelImpl, DetachedTextChannelImpl, DetachedVoiceChannelImpl, ForumChannelImpl, MediaChannelImpl, NewsChannelImpl, StageChannelImpl, TextChannelImpl, VoiceChannelImpl

public interface IPermissionContainerMixin<T extends IPermissionContainerMixin<T>>
extends IPermissionContainer, IPermissionContainerUnion, GuildChannelMixin<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 Type	Method	Description
default IPermissionContainer	getPermissionContainer()	The channel containing the permissions relevant to this channel.
default PermissionOverride	getPermissionOverride(IPermissionHolder permissionHolder)	The PermissionOverride relating to the specified Member or Role.
gnu.trove.map.TLongObjectMap<PermissionOverride>	getPermissionOverrideMap()
default List<PermissionOverride>	getPermissionOverrides()	Gets all of the PermissionOverrides that are part of this GuildChannel.
default PermissionOverrideAction	upsertPermissionOverride(IPermissionHolder permissionHolder)	Creates a new override or updates an existing one.

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

getId, getIdLong, getTimeCreated

Method Details

getPermissionOverride

default PermissionOverride getPermissionOverride(@Nonnull
 IPermissionHolder permissionHolder)

Description copied from interface: IPermissionContainer

The PermissionOverride relating to the specified Member or Role. If there is no PermissionOverride for this GuildChannel relating to the provided Member or Role, then this returns null.

Specified by:

getPermissionOverride in interface IPermissionContainer

Parameters:

permissionHolder - The Member or Role whose PermissionOverride is requested.

Returns:

Possibly-null PermissionOverride relating to the provided Member or Role.

getPermissionOverrides

@Nonnull
default List<PermissionOverride> getPermissionOverrides()

Description copied from interface: IPermissionContainer

Gets all of the PermissionOverrides that are part of this GuildChannel.
This combines Member and Role overrides. If you would like only Member overrides or only Role overrides, use IPermissionContainer.getMemberPermissionOverrides() or IPermissionContainer.getRolePermissionOverrides() respectively.

This requires CacheFlag.MEMBER_OVERRIDES to be enabled! Without that CacheFlag, this list will only contain overrides for the currently logged in account and roles.

Specified by:

getPermissionOverrides in interface IPermissionContainer

Returns:

Possibly-empty immutable list of all PermissionOverrides for this GuildChannel.

upsertPermissionOverride

@Nonnull
default PermissionOverrideAction upsertPermissionOverride(@Nonnull
 IPermissionHolder permissionHolder)

Description copied from interface: IPermissionContainer

Creates a new override or updates an existing one.
This is similar to calling PermissionOverride.getManager() if an override exists.

Specified by:

upsertPermissionOverride in interface IPermissionContainer

Parameters:

permissionHolder - The Member/Role for the override

Returns:

PermissionOverrideAction
With the current settings of an existing override or a fresh override with no permissions set

See Also:

• PermissionOverrideAction.clear(long)
• PermissionOverrideAction.grant(long)
• PermissionOverrideAction.deny(long)

getPermissionContainer

@Nonnull
default IPermissionContainer getPermissionContainer()

Description copied from interface: GuildChannel

The channel containing the permissions relevant to this channel.

This is usually the same channel, but for threads the parent channel is used instead.

Specified by:

getPermissionContainer in interface GuildChannel

Returns:

The permission container

getPermissionOverrideMap

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