Package net.dv8tion.jda.core.managers

Class PermOverrideManager

java.lang.Object

net.dv8tion.jda.core.requests.RestAction<T>

net.dv8tion.jda.core.requests.restaction.AuditableRestAction<java.lang.Void>

net.dv8tion.jda.core.managers.impl.ManagerBase

net.dv8tion.jda.core.managers.PermOverrideManager

public class PermOverrideManager
extends net.dv8tion.jda.core.managers.impl.ManagerBase

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

Example

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

See Also:

PermissionOverride.getManager()

Nested Class Summary

Nested classes/interfaces inherited from class net.dv8tion.jda.core.requests.restaction.AuditableRestAction

AuditableRestAction.EmptyRestAction<T>

Field Summary

Fields

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

Fields inherited from class net.dv8tion.jda.core.requests.RestAction

DEFAULT_FAILURE, DEFAULT_SUCCESS, LOG

Constructor Summary

Constructors

Constructor	Description
PermOverrideManager(PermissionOverride override)	Creates a new PermOverrideManager instance

Method Summary

Modifier and Type	Method	Description
PermOverrideManager	clear(long permissions)	Clears the provided Permissions bits from the selected PermissionOverride.
PermOverrideManager	clear(java.util.Collection<Permission> permissions)	Clears the provided Permissions bits from the selected PermissionOverride.
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.
PermOverrideManager	deny(java.util.Collection<Permission> permissions)	Denies the provided Permissions from the selected PermissionOverride.
PermOverrideManager	deny(Permission... permissions)	Denies the provided Permissions from the selected PermissionOverride.
Channel	getChannel()	The Channel this Manager's PermissionOverride is in.
Guild	getGuild()	The Guild this Manager's Channel 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.
PermOverrideManager	grant(java.util.Collection<Permission> permissions)	Grants the provided Permissions to the selected PermissionOverride.
PermOverrideManager	grant(Permission... permissions)	Grants the provided Permissions to the selected PermissionOverride.
PermOverrideManager	reset()	Resets all fields for this manager.
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 class net.dv8tion.jda.core.requests.restaction.AuditableRestAction

reason, setCheck

Methods inherited from class net.dv8tion.jda.core.managers.impl.ManagerBase

complete, isPermissionChecksEnabled, queue, setPermissionChecksEnabled

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class net.dv8tion.jda.core.requests.RestAction

complete, completeAfter, getJDA, isPassContext, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, setPassContext, submit, submit, submitAfter, submitAfter

Field Detail

DENIED

public static final long DENIED

Used to reset the denied field

See Also:

Constant Field Values

ALLOWED

public static final long ALLOWED

Used to reset the granted field

See Also:

Constant Field Values

PERMISSIONS

public static final long PERMISSIONS

Used to reset all permissions to their original value

See Also:

Constant Field Values

Constructor Detail

PermOverrideManager

public PermOverrideManager(PermissionOverride override)

Creates a new PermOverrideManager instance

Parameters:

override - The PermissionOverride to manage

Method Detail

getGuild

public Guild getGuild()

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

Returns:

The parent Guild

getChannel

public Channel getChannel()

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

Returns:

The parent Channel

getPermissionOverride

public PermissionOverride getPermissionOverride()

The target PermissionOverride that will be modified by this Manager

Returns:

The target PermissionOverride

reset

@CheckReturnValue
public 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

Overrides:

reset in class net.dv8tion.jda.core.managers.impl.ManagerBase

Parameters:

fields - Integer value containing the flags to reset.

Returns:

PermOverrideManager for chaining convenience

reset

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

Resets the fields specified by the provided bit-flag patterns. 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

Overrides:

reset in class net.dv8tion.jda.core.managers.impl.ManagerBase

Parameters:

fields - Integer values containing the flags to reset.

Returns:

PermOverrideManager for chaining convenience

reset

@CheckReturnValue
public PermOverrideManager reset()

Resets all fields for this manager.

Returns:

PermOverrideManager for chaining convenience

grant

@CheckReturnValue
public 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

@CheckReturnValue
public PermOverrideManager grant(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:

java.lang.IllegalArgumentException - If any of the provided Permissions is null

See Also:

Permission.getRaw(Permission...)

grant

@CheckReturnValue
public PermOverrideManager grant(java.util.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:

java.lang.IllegalArgumentException - If any of the provided Permissions is null

See Also:

EnumSet, Permission.getRaw(Collection)

deny

@CheckReturnValue
public 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

@CheckReturnValue
public PermOverrideManager deny(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:

java.lang.IllegalArgumentException - If any of the provided Permissions is null

See Also:

Permission.getRaw(Permission...)

deny

@CheckReturnValue
public PermOverrideManager deny(java.util.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:

java.lang.IllegalArgumentException - If any of the provided Permissions is null

See Also:

EnumSet, Permission.getRaw(Collection)

clear

@CheckReturnValue
public 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

@CheckReturnValue
public PermOverrideManager clear(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:

java.lang.IllegalArgumentException - If any of the provided Permissions is null

clear

@CheckReturnValue
public PermOverrideManager clear(java.util.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:

java.lang.IllegalArgumentException - If any of the provided Permissions is null

See Also:

EnumSet, Permission.getRaw(Collection)