Interface PermOverrideManager

All Superinterfaces:

AuditableRestAction<Void>, Manager<PermOverrideManager>, RestAction<Void>

public interface PermOverrideManager
extends Manager<PermOverrideManager>

Manager providing functionality to update one or more fields for a PermissionOverride.

Example

manager.setDenied(Permission.MESSAGE_SEND)
       .setAllowed(Permission.VIEW_CHANNEL)
       .queue();
manager.reset(PermOverrideManager.DENIED | PermOverrideManager.ALLOWED)
       .grant(Permission.MESSAGE_SEND)
       .clear(Permission.MESSAGE_MANAGE)
       .queue();

See Also:

• PermissionOverride.getManager()

Field Summary

Fields

Modifier and Type	Field	Description
static final long	ALLOWED	Used to reset the granted field
static final long	DENIED	Used to reset the denied field
static final long	PERMISSIONS	Used to reset all permissions to their original value

Fields inherited from interface AuditableRestAction

MAX_REASON_LENGTH

Method Summary

Modifier and Type	Method	Description
PermOverrideManager	clear(long permissions)	Clears the provided Permissions bits from the selected PermissionOverride.
default PermOverrideManager	clear(Collection<Permission> permissions)	Clears the provided Permissions bits from the selected PermissionOverride.
default PermOverrideManager	clear(Permission... permissions)	Clears the provided Permissions bits from the selected PermissionOverride.
PermOverrideManager	deny(long permissions)	Denies the provided Permissions bits from the selected PermissionOverride.
default PermOverrideManager	deny(Collection<Permission> permissions)	Denies the provided Permissions from the selected PermissionOverride.
default PermOverrideManager	deny(Permission... permissions)	Denies the provided Permissions from the selected PermissionOverride.
default IPermissionContainerUnion	getChannel()	The GuildChannel this Manager's PermissionOverride is in.
default Guild	getGuild()	The Guild this Manager's GuildChannel is in.
PermissionOverride	getPermissionOverride()	The target PermissionOverride that will be modified by this Manager
PermOverrideManager	grant(long permissions)	Grants the provided Permissions bits to the selected PermissionOverride.
default PermOverrideManager	grant(Collection<Permission> permissions)	Grants the provided Permissions to the selected PermissionOverride.
default PermOverrideManager	grant(Permission... permissions)	Grants the provided Permissions to the selected PermissionOverride.
PermOverrideManager	reset(long fields)	Resets the fields specified by the provided bit-flag pattern.
PermOverrideManager	reset(long... fields)	Resets the fields specified by the provided bit-flag patterns.

Methods inherited from interface AuditableRestAction

reason

Methods inherited from interface Manager

deadline, reset, setCheck, timeout

Methods inherited from interface RestAction

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

Field Details

DENIED

static final long DENIED

Used to reset the denied field

See Also:

• Constant Field Values

ALLOWED

static final long ALLOWED

Used to reset the granted field

See Also:

• Constant Field Values

PERMISSIONS

static final long PERMISSIONS

Used to reset all permissions to their original value

See Also:

• Constant Field Values

Method Details

reset

@Nonnull
@CheckReturnValue
PermOverrideManager reset(long fields)

Resets the fields specified by the provided bit-flag pattern. You can specify a combination by using a bitwise OR concat of the flag constants.
Example: manager.reset(PermOverrideManager.ALLOWED | PermOverrideManager.DENIED);

Flag Constants:

• DENIED
• ALLOWED
• PERMISSIONS

Specified by:

reset in interface Manager<PermOverrideManager>

Parameters:

fields - Integer value containing the flags to reset.

Returns:

PermOverrideManager for chaining convenience

reset

@Nonnull
@CheckReturnValue
PermOverrideManager reset(@Nonnull
 long... fields)

Resets the fields specified by the provided bit-flag patterns.
Example: manager.reset(PermOverrideManager.ALLOWED, PermOverrideManager.DENIED);

Flag Constants:

• DENIED
• ALLOWED
• PERMISSIONS

Specified by:

reset in interface Manager<PermOverrideManager>

Parameters:

fields - Integer values containing the flags to reset.

Returns:

PermOverrideManager for chaining convenience

getGuild

@Nonnull
default Guild getGuild()

The Guild this Manager's GuildChannel is in.
This is logically the same as calling getPermissionOverride().getGuild()

Returns:

The parent Guild

getChannel

@Nonnull
default IPermissionContainerUnion getChannel()

The GuildChannel this Manager's PermissionOverride is in.
This is logically the same as calling getPermissionOverride().getChannel()

Returns:

The parent GuildChannel

getPermissionOverride

@Nonnull
PermissionOverride getPermissionOverride()

The target PermissionOverride that will be modified by this Manager

Returns:

The target PermissionOverride

grant

@Nonnull
@CheckReturnValue
PermOverrideManager grant(long permissions)

Grants the provided Permissions bits to the selected PermissionOverride.

Parameters:

permissions - The permissions to grant to the selected PermissionOverride

Returns:

PermOverrideManager for chaining convenience

grant

@Nonnull
@CheckReturnValue
default PermOverrideManager grant(@Nonnull
 Permission... permissions)

Grants the provided Permissions to the selected PermissionOverride.

Parameters:

permissions - The permissions to grant to the selected PermissionOverride

Returns:

PermOverrideManager for chaining convenience

Throws:

IllegalArgumentException - If any of the provided Permissions is null

See Also:

• Permission.getRaw(Permission...)

grant

@Nonnull
@CheckReturnValue
default PermOverrideManager grant(@Nonnull
 Collection<Permission> permissions)

Grants the provided Permissions to the selected PermissionOverride.

Parameters:

permissions - The permissions to grant to the selected PermissionOverride

Returns:

PermOverrideManager for chaining convenience

Throws:

IllegalArgumentException - If any of the provided Permissions is null

See Also:

• EnumSet
• Permission.getRaw(Collection)

deny

@Nonnull
@CheckReturnValue
PermOverrideManager deny(long permissions)

Denies the provided Permissions bits from the selected PermissionOverride.

Parameters:

permissions - The permissions to deny from the selected PermissionOverride

Returns:

PermOverrideManager for chaining convenience

deny

@Nonnull
@CheckReturnValue
default PermOverrideManager deny(@Nonnull
 Permission... permissions)

Denies the provided Permissions from the selected PermissionOverride.

Parameters:

permissions - The permissions to deny from the selected PermissionOverride

Returns:

PermOverrideManager for chaining convenience

Throws:

IllegalArgumentException - If any of the provided Permissions is null

See Also:

• Permission.getRaw(Permission...)

deny

@Nonnull
@CheckReturnValue
default PermOverrideManager deny(@Nonnull
 Collection<Permission> permissions)

Denies the provided Permissions from the selected PermissionOverride.

Parameters:

permissions - The permissions to deny from the selected PermissionOverride

Returns:

PermOverrideManager for chaining convenience

Throws:

IllegalArgumentException - If any of the provided Permissions is null

See Also:

• EnumSet
• Permission.getRaw(Collection)

clear

@Nonnull
@CheckReturnValue
PermOverrideManager clear(long permissions)

Clears the provided Permissions bits from the selected PermissionOverride.
This will cause the provided Permissions to be inherited

Parameters:

permissions - The permissions to clear from the selected PermissionOverride

Returns:

PermOverrideManager for chaining convenience

clear

@Nonnull
@CheckReturnValue
default PermOverrideManager clear(@Nonnull
 Permission... permissions)

Clears the provided Permissions bits from the selected PermissionOverride.
This will cause the provided Permissions to be inherited

Parameters:

permissions - The permissions to clear from the selected PermissionOverride

Returns:

PermOverrideManager for chaining convenience

Throws:

IllegalArgumentException - If any of the provided Permissions is null

clear

@Nonnull
@CheckReturnValue
default PermOverrideManager clear(@Nonnull
 Collection<Permission> permissions)

Clears the provided Permissions bits from the selected PermissionOverride.
This will cause the provided Permissions to be inherited

Parameters:

permissions - The permissions to clear from the selected PermissionOverride

Returns:

PermOverrideManager for chaining convenience

Throws:

IllegalArgumentException - If any of the provided Permissions is null

See Also:

• EnumSet
• Permission.getRaw(Collection)