Package net.dv8tion.jda.internal.requests.restaction

Class PermissionOverrideActionImpl

java.lang.Object

net.dv8tion.jda.internal.requests.RestActionImpl<PermissionOverride>

net.dv8tion.jda.internal.requests.restaction.AuditableRestActionImpl<PermissionOverride>

net.dv8tion.jda.internal.requests.restaction.PermissionOverrideActionImpl

All Implemented Interfaces:

RestAction<PermissionOverride>, AuditableRestAction<PermissionOverride>, PermissionOverrideAction

public class PermissionOverrideActionImpl
extends AuditableRestActionImpl<PermissionOverride>
implements PermissionOverrideAction

Field Summary

Fields inherited from class net.dv8tion.jda.internal.requests.RestActionImpl

LOG

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

MAX_REASON_LENGTH

Constructor Summary

Constructors

Constructor	Description
PermissionOverrideActionImpl(PermissionOverride override)
PermissionOverrideActionImpl(JDA api, GuildChannel channel, IPermissionHolder permissionHolder)

Method Summary

Modifier and Type	Method	Description
PermissionOverrideAction	clear(long inheritedBits)	Clears the provided Permissions bits from the PermissionOverride.
PermissionOverrideActionImpl	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
PermissionOverrideAction	deny(long denyBits)	Denies the specified permissions.
long	getAllowed()	The currently set of allowed permission bits.
IPermissionContainer	getChannel()	The IPermissionContainer this will be created in
long	getDenied()	The currently set of denied permission bits.
long	getInherited()	The currently set of inherited permission bits.
Member	getMember()	The Member for this override
Role	getRole()	The Role for this override
PermissionOverrideAction	grant(long allowBits)	Grants the specified permissions.
boolean	isMember()	Whether this Action will create a PermissionOverride for a Member or not
boolean	isRole()	Whether this Action will create a PermissionOverride for a Role or not
PermissionOverrideAction	resetAllow()	Resets the allowed permissions to the current original value.
PermissionOverrideAction	resetDeny()	Resets the denied permissions to the current original value.
PermissionOverrideActionImpl	setAllowed(long allowBits)	Sets the value of explicitly granted permissions using the bitwise representation of a set of Permissions.
PermissionOverrideActionImpl	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
PermissionOverrideActionImpl	setDenied(long denyBits)	Sets the value of explicitly denied permissions using the bitwise representation of a set of Permissions.
PermissionOverrideActionImpl	setOverride(boolean override)
PermissionOverrideActionImpl	setPermissions(long allowBits, long denyBits)	Combination of PermissionOverrideAction.setAllowed(long) and PermissionOverrideAction.setDenied(long) First sets the allow bits and then the deny bits.
PermissionOverrideActionImpl	timeout(long timeout, TimeUnit unit)	Timeout for this RestAction instance.

Methods inherited from class net.dv8tion.jda.internal.requests.restaction.AuditableRestActionImpl

reason

Methods inherited from class net.dv8tion.jda.internal.requests.RestActionImpl

complete, getCheck, getDefaultFailure, getDefaultSuccess, getDefaultTimeout, getJDA, handleResponse, isPassContext, priority, queue, setDefaultFailure, setDefaultSuccess, setDefaultTimeout, setErrorMapper, setPassContext, submit

Methods inherited from class java.lang.Object

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

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

reason

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

clear, clear, deny, deny, getAllowedPermissions, getDeniedPermissions, getGuild, getInheritedPermissions, grant, grant, reset, setAllowed, setAllowed, setDenied, setDenied, setPermissions

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, onSuccess, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, submit, submit, submitAfter, submitAfter, zip

Constructor Details

PermissionOverrideActionImpl

public PermissionOverrideActionImpl(PermissionOverride override)

PermissionOverrideActionImpl

public PermissionOverrideActionImpl(JDA api,
 GuildChannel channel,
 IPermissionHolder permissionHolder)

Method Details

setOverride

public PermissionOverrideActionImpl setOverride(boolean override)

setCheck

@Nonnull
public PermissionOverrideActionImpl setCheck(BooleanSupplier checks)

Description copied from interface: RestAction

Sets the last-second checks before finally executing the http request in the queue.
If the provided supplier evaluates to false or throws an exception this will not be finished. When an exception is thrown from the supplier it will be provided to the failure callback.

Specified by:

setCheck in interface AuditableRestAction<PermissionOverride>

Specified by:

setCheck in interface PermissionOverrideAction

Specified by:

setCheck in interface RestAction<PermissionOverride>

Overrides:

setCheck in class AuditableRestActionImpl<PermissionOverride>

Parameters:

checks - The checks to run before executing the request, or null to run no checks

Returns:

The current RestAction for chaining convenience

See Also:

• RestAction.getCheck()
• RestAction.addCheck(BooleanSupplier)

timeout

@Nonnull
public PermissionOverrideActionImpl timeout(long timeout,
 @Nonnull
 TimeUnit unit)

Description copied from interface: AuditableRestAction

Timeout for this RestAction instance.
If the request doesn't get executed within the timeout it will fail.

When a RestAction times out, it will fail with a TimeoutException. This is the same as deadline(System.currentTimeMillis() + unit.toMillis(timeout)).

Example

 action.timeout(10, TimeUnit.SECONDS) // 10 seconds from now
       .queueAfter(20, SECONDS); // request will not be executed within deadline and timeout immediately after 20 seconds
 

Specified by:

timeout in interface AuditableRestAction<PermissionOverride>

Specified by:

timeout in interface PermissionOverrideAction

Specified by:

timeout in interface RestAction<PermissionOverride>

Overrides:

timeout in class AuditableRestActionImpl<PermissionOverride>

Parameters:

timeout - The timeout to use

unit - Unit for the timeout value

Returns:

The same RestAction instance with the applied timeout

See Also:

• RestAction.setDefaultTimeout(long, TimeUnit)

deadline

@Nonnull
public PermissionOverrideActionImpl deadline(long timestamp)

Description copied from interface: RestAction

Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
If the deadline is reached, the request will fail with a TimeoutException.

This does not mean that the request will immediately timeout when the deadline is reached. JDA will check the deadline right before executing the request or within intervals in a worker thread. This only means the request will timeout if the deadline has passed.

Example

 action.deadline(System.currentTimeMillis() + 10000) // 10 seconds from now
       .queueAfter(20, SECONDS); // request will not be executed within deadline and timeout immediately after 20 seconds
 

Specified by:

deadline in interface AuditableRestAction<PermissionOverride>

Specified by:

deadline in interface PermissionOverrideAction

Specified by:

deadline in interface RestAction<PermissionOverride>

Overrides:

deadline in class AuditableRestActionImpl<PermissionOverride>

Parameters:

timestamp - Millisecond timestamp at which the request will timeout

Returns:

The same RestAction with the applied deadline

See Also:

• RestAction.timeout(long, TimeUnit)
• RestAction.setDefaultTimeout(long, TimeUnit)

resetAllow

@Nonnull
public PermissionOverrideAction resetAllow()

Description copied from interface: PermissionOverrideAction

Resets the allowed permissions to the current original value.
For a new override this will just be 0.

Specified by:

resetAllow in interface PermissionOverrideAction

Returns:

The current PermissionOverrideAction for chaining convenience

resetDeny

@Nonnull
public PermissionOverrideAction resetDeny()

Description copied from interface: PermissionOverrideAction

Resets the denied permissions to the current original value.
For a new override this will just be 0.

Specified by:

resetDeny in interface PermissionOverrideAction

Returns:

The current PermissionOverrideAction for chaining convenience

getChannel

@Nonnull
public IPermissionContainer getChannel()

Description copied from interface: PermissionOverrideAction

The IPermissionContainer this will be created in

Specified by:

getChannel in interface PermissionOverrideAction

Returns:

The channel

getRole

public Role getRole()

Description copied from interface: PermissionOverrideAction

The Role for this override

Specified by:

getRole in interface PermissionOverrideAction

Returns:

The role, or null if this is a member override

getMember

public Member getMember()

Description copied from interface: PermissionOverrideAction

The Member for this override

Specified by:

getMember in interface PermissionOverrideAction

Returns:

The member, or null if this is a role override

getAllowed

public long getAllowed()

Description copied from interface: PermissionOverrideAction

The currently set of allowed permission bits.
This value represents all granted permissions in the raw bitwise representation.

Use PermissionOverrideAction.getAllowedPermissions() to retrieve a List with Permissions for this value

Specified by:

getAllowed in interface PermissionOverrideAction

Returns:

long value of granted permissions

getDenied

public long getDenied()

Description copied from interface: PermissionOverrideAction

The currently set of denied permission bits.
This value represents all denied permissions in the raw bitwise representation.

Use PermissionOverrideAction.getDeniedPermissions() to retrieve a List with Permissions for this value

Specified by:

getDenied in interface PermissionOverrideAction

Returns:

long value of denied permissions

getInherited

public long getInherited()

Description copied from interface: PermissionOverrideAction

The currently set of inherited permission bits.
This value represents all permissions that are not explicitly allowed or denied in their raw bitwise representation.
Inherited Permissions are permissions that are defined by other rules from maybe other PermissionOverrides or a Role.

Use PermissionOverrideAction.getInheritedPermissions() to retrieve a List with Permissions for this value

Specified by:

getInherited in interface PermissionOverrideAction

Returns:

long value of inherited permissions

isMember

public boolean isMember()

Description copied from interface: PermissionOverrideAction

Whether this Action will create a PermissionOverride for a Member or not

Specified by:

isMember in interface PermissionOverrideAction

Returns:

True, if this is targeting a Member If this is false it is targeting a Role. (PermissionOverrideAction.isRole())

isRole

public boolean isRole()

Description copied from interface: PermissionOverrideAction

Whether this Action will create a PermissionOverride for a Role or not

Specified by:

isRole in interface PermissionOverrideAction

Returns:

True, if this is targeting a Role. If this is false it is targeting a Member. (PermissionOverrideAction.isMember())

setAllowed

@Nonnull
@CheckReturnValue
public PermissionOverrideActionImpl setAllowed(long allowBits)

Description copied from interface: PermissionOverrideAction

Sets the value of explicitly granted permissions using the bitwise representation of a set of Permissions.
This value can be retrieved through Permissions.getRaw(Permission...)!
Note: Permissions not marked as isChannel() will have no affect!

All newly granted permissions will be removed from the currently set denied permissions.
allow = allowBits; deny = deny & ~allowBits;

Specified by:

setAllowed in interface PermissionOverrideAction

Parameters:

allowBits - The positive bits representing the granted permissions for the new PermissionOverride

Returns:

The current PermissionOverrideAction - for chaining convenience

See Also:

• setAllow(Collection)
• setAllow(Permission...)

grant

@Nonnull
public PermissionOverrideAction grant(long allowBits)

Description copied from interface: PermissionOverrideAction

Grants the specified permissions.
This does not override already granted permissions.

Specified by:

grant in interface PermissionOverrideAction

Parameters:

allowBits - The permissions to grant, in addition to already allowed permissions

Returns:

The current PermissionOverrideAction - for chaining convenience

setDenied

@Nonnull
@CheckReturnValue
public PermissionOverrideActionImpl setDenied(long denyBits)

Description copied from interface: PermissionOverrideAction

Sets the value of explicitly denied permissions using the bitwise representation of a set of Permissions.
This value can be retrieved through Permissions.getRaw(Permission...)!
Note: Permissions not marked as isChannel() will have no affect!

All newly denied permissions will be removed from the currently set allowed permissions.
deny = denyBits; allow = allow & ~denyBits;

Specified by:

setDenied in interface PermissionOverrideAction

Parameters:

denyBits - The positive bits representing the denied permissions for the new PermissionOverride

Returns:

The current PermissionOverrideAction - for chaining convenience

See Also:

• setDeny(Collection)
• setDeny(Permission...)

deny

@Nonnull
public PermissionOverrideAction deny(long denyBits)

Description copied from interface: PermissionOverrideAction

Denies the specified permissions.
This does not override already denied permissions.

Specified by:

deny in interface PermissionOverrideAction

Parameters:

denyBits - The permissions to deny, in addition to already denied permissions

Returns:

The current PermissionOverrideAction - for chaining convenience

clear

@Nonnull
public PermissionOverrideAction clear(long inheritedBits)

Description copied from interface: PermissionOverrideAction

Clears the provided Permissions bits from the PermissionOverride.
This will cause the provided Permissions to be inherited from other overrides or roles.

Specified by:

clear in interface PermissionOverrideAction

Parameters:

inheritedBits - The permissions to clear from the PermissionOverride

Returns:

The current PermissionOverrideAction - for chaining convenience

setPermissions

@Nonnull
@CheckReturnValue
public PermissionOverrideActionImpl setPermissions(long allowBits,
 long denyBits)

Description copied from interface: PermissionOverrideAction

Combination of PermissionOverrideAction.setAllowed(long) and PermissionOverrideAction.setDenied(long)
First sets the allow bits and then the deny bits.

Specified by:

setPermissions in interface PermissionOverrideAction

Parameters:

allowBits - An unsigned bitwise representation of granted Permissions

denyBits - An unsigned bitwise representation of denied Permissions

Returns:

The current PermissionOverrideAction - for chaining convenience

See Also:

• PermissionOverrideAction.setPermissions(java.util.Collection, java.util.Collection)
• Permission.getRaw(Permission...)
• Permission.getRaw(Collection)