Package net.dv8tion.jda.api.entities

Interface IPermissionContainer

All Superinterfaces:

Channel, Comparable<GuildChannel>, Formattable, GuildChannel, IMentionable, ISnowflake

All Known Subinterfaces:

BaseGuildMessageChannel, Category, ICategorizableChannel, IThreadContainer, NewsChannel, StageChannel, StoreChannel, TextChannel, VoiceChannel

public interface IPermissionContainer
extends GuildChannel

Represents a GuildChannel that uses Permission Overrides. Channels that implement this interface can override permissions for specific users or roles.

See Also:

• PermissionOverride

Method Summary

Modifier and Type	Method	Description
default PermissionOverrideAction	createPermissionOverride(IPermissionHolder permissionHolder)	Creates a PermissionOverride for the specified Member or Role in this GuildChannel.
IPermissionContainerManager<?,?>	getManager()	Returns the ChannelManager for this GuildChannel.
default List<PermissionOverride>	getMemberPermissionOverrides()	Gets all of the Member PermissionOverrides that are part of this GuildChannel.
PermissionOverride	getPermissionOverride(IPermissionHolder permissionHolder)	The PermissionOverride relating to the specified Member or Role.
List<PermissionOverride>	getPermissionOverrides()	Gets all of the PermissionOverrides that are part of this GuildChannel.
default List<PermissionOverride>	getRolePermissionOverrides()	Gets all of the Role PermissionOverrides that are part of this GuildChannel.
PermissionOverrideAction	putPermissionOverride(IPermissionHolder permissionHolder)	Creates a PermissionOverride for the specified Member or Role in 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

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

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

getId, getIdLong, getTimeCreated

Method Details

getManager

@Nonnull
IPermissionContainerManager<?,?> 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

Returns:

The ChannelManager of this GuildChannel

getPermissionOverride

@Nullable
PermissionOverride getPermissionOverride(@Nonnull
 IPermissionHolder permissionHolder)

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.

Parameters:

permissionHolder - The Member or Role whose PermissionOverride is requested.

Returns:

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

Throws:

IllegalArgumentException - If the provided permission holder is null, or from a different guild

getPermissionOverrides

@Nonnull
List<PermissionOverride> getPermissionOverrides()

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 getMemberPermissionOverrides() or 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.

Returns:

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

getMemberPermissionOverrides

@Nonnull
default List<PermissionOverride> getMemberPermissionOverrides()

Gets all of the Member PermissionOverrides that are part of this GuildChannel.

This requires CacheFlag.MEMBER_OVERRIDES to be enabled!

Returns:

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

getRolePermissionOverrides

@Nonnull
default List<PermissionOverride> getRolePermissionOverrides()

Gets all of the Role PermissionOverrides that are part of this GuildChannel.

Returns:

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

createPermissionOverride

@Nonnull
@CheckReturnValue
default PermissionOverrideAction createPermissionOverride(@Nonnull
 IPermissionHolder permissionHolder)

Creates a PermissionOverride for the specified Member or Role in this GuildChannel. You can use putPermissionOverride(IPermissionHolder) to replace existing overrides.

Possible ErrorResponses include:

• UNKNOWN_CHANNEL
  If this channel was already deleted
• MISSING_ACCESS
  If we were removed from the Guild

Parameters:

permissionHolder - The Member or Role to create an override for

Returns:

PermissionOverrideAction Provides the newly created PermissionOverride for the specified permission holder

Throws:

InsufficientPermissionException - if we don't have the permission to MANAGE_PERMISSIONS

IllegalArgumentException - if the specified permission holder is null or is not from GuildChannel.getGuild()

IllegalStateException - If the specified permission holder already has a PermissionOverride. Use getPermissionOverride(IPermissionHolder) to retrieve it. You can use putPermissionOverride(IPermissionHolder) to replace existing overrides.

putPermissionOverride

@Nonnull
@CheckReturnValue
PermissionOverrideAction putPermissionOverride(@Nonnull
 IPermissionHolder permissionHolder)

Creates a PermissionOverride for the specified Member or Role in this GuildChannel.
If the permission holder already has an existing override it will be replaced.

Parameters:

permissionHolder - The Member or Role to create the override for

Returns:

PermissionOverrideAction Provides the newly created PermissionOverride for the specified permission holder

Throws:

InsufficientPermissionException - if we don't have the permission to MANAGE_PERMISSIONS

IllegalArgumentException - If the provided permission holder is null or from a different guild

upsertPermissionOverride

@Nonnull
@CheckReturnValue
default PermissionOverrideAction upsertPermissionOverride(@Nonnull
 IPermissionHolder permissionHolder)

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

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

Throws:

InsufficientPermissionException - If we don't have the permission to MANAGE_PERMISSIONS

IllegalArgumentException - If the provided permission holder is null or not from this guild

Since:

4.0.0