Package net.dv8tion.jda.api.managers.channel.attribute

Interface IPermissionContainerManager<T extends IPermissionContainer,M extends IPermissionContainerManager<T,M>>

All Superinterfaces:

AuditableRestAction<Void>, ChannelManager<T,M>, Manager<M>, RestAction<Void>

All Known Subinterfaces:

BaseGuildMessageChannelManager<T,M>, CategoryManager, ICategorizableChannelManager<T,M>, NewsChannelManager, StageChannelManager, StoreChannelManager, TextChannelManager, VoiceChannelManager

public interface IPermissionContainerManager<T extends IPermissionContainer,M extends IPermissionContainerManager<T,M>>
extends ChannelManager<T,M>

Field Summary

Fields inherited from interface net.dv8tion.jda.api.managers.channel.ChannelManager

ARCHIVED, AUTO_ARCHIVE_DURATION, BITRATE, INVITEABLE, LOCKED, NAME, NSFW, PARENT, PERMISSION, POSITION, REGION, SLOWMODE, TOPIC, TYPE, USERLIMIT

Method Summary

Modifier and Type	Method	Description
M	clearOverridesAdded()	Clears the overrides added via putPermissionOverride(IPermissionHolder, Collection, Collection).
M	clearOverridesRemoved()	Clears the overrides removed via removePermissionOverride(IPermissionHolder).
M	putMemberPermissionOverride(long memberId, long allow, long deny)	Adds an override for the specified member with the provided raw bitmasks as allowed and denied permissions.
default M	putMemberPermissionOverride(long memberId, Collection<Permission> allow, Collection<Permission> deny)	Adds an override for the specified member with the provided permission sets as allowed and denied permissions.
M	putPermissionOverride(IPermissionHolder permHolder, long allow, long deny)	Adds an override for the specified IPermissionHolder with the provided raw bitmasks as allowed and denied permissions.
default M	putPermissionOverride(IPermissionHolder permHolder, Collection<Permission> allow, Collection<Permission> deny)	Adds an override for the specified IPermissionHolder with the provided permission sets as allowed and denied permissions.
M	putRolePermissionOverride(long roleId, long allow, long deny)	Adds an override for the specified role with the provided raw bitmasks as allowed and denied permissions.
default M	putRolePermissionOverride(long roleId, Collection<Permission> allow, Collection<Permission> deny)	Adds an override for the specified role with the provided permission sets as allowed and denied permissions.
M	removePermissionOverride(long id)	Removes the PermissionOverride for the specified member or role ID.
M	removePermissionOverride(IPermissionHolder permHolder)	Removes the PermissionOverride for the specified IPermissionHolder.

Methods inherited from interface net.dv8tion.jda.api.requests.restaction.AuditableRestAction

reason

Methods inherited from interface net.dv8tion.jda.api.managers.channel.ChannelManager

getChannel, getGuild, reset, reset, setName

Methods inherited from interface net.dv8tion.jda.api.managers.Manager

deadline, reset, setCheck, timeout

Methods inherited from interface net.dv8tion.jda.api.requests.RestAction

addCheck, and, and, complete, complete, completeAfter, delay, delay, delay, delay, flatMap, flatMap, getCheck, getJDA, map, mapToResult, onErrorFlatMap, onErrorFlatMap, onErrorMap, onErrorMap, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, submit, submit, submitAfter, submitAfter, zip

Method Detail

clearOverridesAdded

@Nonnull
@CheckReturnValue
M clearOverridesAdded()

Clears the overrides added via putPermissionOverride(IPermissionHolder, Collection, Collection).

Returns:

ChannelManager for chaining convenience

clearOverridesRemoved

@Nonnull
@CheckReturnValue
M clearOverridesRemoved()

Clears the overrides removed via removePermissionOverride(IPermissionHolder).

Returns:

ChannelManager for chaining convenience

putPermissionOverride

@Nonnull
@CheckReturnValue
M putPermissionOverride(@Nonnull
                        IPermissionHolder permHolder,
                        long allow,
                        long deny)

Adds an override for the specified IPermissionHolder with the provided raw bitmasks as allowed and denied permissions. If the permission holder already had an override on this channel it will be replaced instead.

Parameters:

permHolder - The permission holder

allow - The bitmask to grant

deny - The bitmask to deny

Returns:

ChannelManager for chaining convenience

Throws:

IllegalArgumentException - If the provided permission holder is null

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_PERMISSIONS in this channel, or tries to set permissions it does not have without having Permission.MANAGE_PERMISSIONS explicitly for this channel through an override.

See Also:

putPermissionOverride(IPermissionHolder, Collection, Collection), Permission.getRaw(Permission...)

putPermissionOverride

@Nonnull
@CheckReturnValue
default M putPermissionOverride(@Nonnull
                                IPermissionHolder permHolder,
                                @Nullable
                                Collection<Permission> allow,
                                @Nullable
                                Collection<Permission> deny)

Adds an override for the specified IPermissionHolder with the provided permission sets as allowed and denied permissions. If the permission holder already had an override on this channel it will be replaced instead.
Example: putPermissionOverride(guild.getSelfMember(), EnumSet.of(Permission.MESSAGE_SEND, Permission.VIEW_CHANNEL), null)

Parameters:

permHolder - The permission holder

allow - The permissions to grant, or null

deny - The permissions to deny, or null

Returns:

ChannelManager for chaining convenience

Throws:

IllegalArgumentException - If the provided permission holder is null

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_PERMISSIONS in this channel, or tries to set permissions it does not have without having Permission.MANAGE_PERMISSIONS explicitly for this channel through an override.

See Also:

putPermissionOverride(IPermissionHolder, long, long), EnumSet

putRolePermissionOverride

@Nonnull
@CheckReturnValue
M putRolePermissionOverride(long roleId,
                            long allow,
                            long deny)

Adds an override for the specified role with the provided raw bitmasks as allowed and denied permissions. If the role already had an override on this channel it will be replaced instead.

Parameters:

roleId - The ID of the role to set permissions for

allow - The bitmask to grant

deny - The bitmask to deny

Returns:

ChannelManager for chaining convenience

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_PERMISSIONS in this channel, or tries to set permissions it does not have without having Permission.MANAGE_PERMISSIONS explicitly for this channel through an override.

See Also:

putRolePermissionOverride(long, Collection, Collection), Permission.getRaw(Permission...)

putRolePermissionOverride

@Nonnull
@CheckReturnValue
default M putRolePermissionOverride(long roleId,
                                    @Nullable
                                    Collection<Permission> allow,
                                    @Nullable
                                    Collection<Permission> deny)

Adds an override for the specified role with the provided permission sets as allowed and denied permissions. If the role already had an override on this channel it will be replaced instead.

Parameters:

roleId - The ID of the role to set permissions for

allow - The permissions to grant, or null

deny - The permissions to deny, or null

Returns:

ChannelManager for chaining convenience

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_PERMISSIONS in this channel, or tries to set permissions it does not have without having Permission.MANAGE_PERMISSIONS explicitly for this channel through an override.

See Also:

putRolePermissionOverride(long, long, long), EnumSet

putMemberPermissionOverride

@Nonnull
@CheckReturnValue
M putMemberPermissionOverride(long memberId,
                              long allow,
                              long deny)

Adds an override for the specified member with the provided raw bitmasks as allowed and denied permissions. If the member already had an override on this channel it will be replaced instead.

Parameters:

memberId - The ID of the member to set permissions for

allow - The bitmask to grant

deny - The bitmask to deny

Returns:

ChannelManager for chaining convenience

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_PERMISSIONS in this channel, or tries to set permissions it does not have without having Permission.MANAGE_PERMISSIONS explicitly for this channel through an override.

See Also:

putMemberPermissionOverride(long, Collection, Collection), Permission.getRaw(Permission...)

putMemberPermissionOverride

@Nonnull
@CheckReturnValue
default M putMemberPermissionOverride(long memberId,
                                      @Nullable
                                      Collection<Permission> allow,
                                      @Nullable
                                      Collection<Permission> deny)

Adds an override for the specified member with the provided permission sets as allowed and denied permissions. If the member already had an override on this channel it will be replaced instead.

Parameters:

memberId - The ID of the member to set permissions for

allow - The permissions to grant, or null

deny - The permissions to deny, or null

Returns:

ChannelManager for chaining convenience

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_PERMISSIONS in this channel, or tries to set permissions it does not have without having Permission.MANAGE_PERMISSIONS explicitly for this channel through an override.

See Also:

putMemberPermissionOverride(long, long, long), EnumSet

removePermissionOverride

@Nonnull
@CheckReturnValue
M removePermissionOverride(@Nonnull
                           IPermissionHolder permHolder)

Removes the PermissionOverride for the specified IPermissionHolder. If no override existed for this member or role, this does nothing.

Parameters:

permHolder - The permission holder

Returns:

ChannelManager for chaining convenience

Throws:

IllegalArgumentException - If the provided permission holder is null

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_PERMISSIONS in this channel

removePermissionOverride

@Nonnull
@CheckReturnValue
M removePermissionOverride(long id)

Removes the PermissionOverride for the specified member or role ID. If no override existed for this member or role, this does nothing.

Parameters:

id - The ID of the permission holder

Returns:

ChannelManager for chaining convenience

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_PERMISSIONS in this channel