net.dv8tion.jda.core.managers

Class PermOverrideManager

java.lang.Object

net.dv8tion.jda.core.managers.PermOverrideManager

public class PermOverrideManager
extends java.lang.Object

Facade for a PermOverrideManagerUpdatable instance.
Simplifies managing flow for convenience.

This decoration allows to modify a single field by automatically building an update RestAction

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
RestAction<java.lang.Void>	clear(java.util.Collection<Permission> permissions) Clears the provided Permissions bits from the selected PermissionOverridie.
RestAction<java.lang.Void>	clear(long permissions) Clears the provided Permissions bits from the selected PermissionOverridie.
RestAction<java.lang.Void>	clear(Permission... permissions) Clears the provided Permissions bits from the selected PermissionOverridie.
RestAction<java.lang.Void>	deny(java.util.Collection<Permission> permissions) Denies the provided Permissions from the selected PermissionOverridie.
RestAction<java.lang.Void>	deny(long permissions) Denies the provided Permissions bits from the selected PermissionOverridie.
RestAction<java.lang.Void>	deny(Permission... permissions) Denies the provided Permissions from the selected PermissionOverridie.
Channel	getChannel() The Channel this Manager's PermissionOverride is in.
Guild	getGuild() The Guild this Manager's Channel is in.
JDA	getJDA() The JDA instance of this Manager
PermissionOverride	getPermissionOverride() The target PermissionOverride that will be modified by this Manager
RestAction<java.lang.Void>	grant(java.util.Collection<Permission> permissions) Grants the provided Permissions to the selected PermissionOverridie.
RestAction<java.lang.Void>	grant(long permissions) Grants the provided Permissions bits to the selected PermissionOverridie.
RestAction<java.lang.Void>	grant(Permission... permissions) Grants the provided Permissions to the selected PermissionOverridie.

Methods inherited from class java.lang.Object

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

Constructor Detail

PermOverrideManager

public PermOverrideManager(PermissionOverride override)

Creates a new PermOverrideManager instance

Parameters:

override - The PermissionOverride to manage

Method Detail

getJDA

public JDA getJDA()

The JDA instance of this Manager

Returns:

the corresponding JDA instance

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

grant

public RestAction<java.lang.Void> grant(long permissions)

Grants the provided Permissions bits to the selected PermissionOverridie.
Wraps PermOverrideManagerUpdatable.grant(long)

Parameters:

permissions - The permissions to grant to the selected PermissionOverride

Returns:

RestAction
Update RestAction from #update()

Throws:

PermissionException - If the currently logged in account does not have the Permission MANAGE_PERMISSIONS

See Also:

PermOverrideManagerUpdatable.grant(long), PermOverrideManagerUpdatable.update()

grant

public RestAction<java.lang.Void> grant(Permission... permissions)

Grants the provided Permissions to the selected PermissionOverridie.
Wraps PermOverrideManagerUpdatable.grant(long)

Parameters:

permissions - The permissions to grant to the selected PermissionOverride

Returns:

RestAction
Update RestAction from #update()

Throws:

PermissionException - If the currently logged in account does not have the Permission MANAGE_PERMISSIONS

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

See Also:

PermOverrideManagerUpdatable.grant(Permission...), PermOverrideManagerUpdatable.update()

grant

public RestAction<java.lang.Void> grant(java.util.Collection<Permission> permissions)

Grants the provided Permissions to the selected PermissionOverridie.
Wraps PermOverrideManagerUpdatable.grant(long)

Parameters:

permissions - The permissions to grant to the selected PermissionOverride

Returns:

RestAction
Update RestAction from #update()

Throws:

PermissionException - If the currently logged in account does not have the Permission MANAGE_PERMISSIONS

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

See Also:

PermOverrideManagerUpdatable.grant(Collection), PermOverrideManagerUpdatable.update()

deny

public RestAction<java.lang.Void> deny(long permissions)

Denies the provided Permissions bits from the selected PermissionOverridie.
Wraps PermOverrideManagerUpdatable.deny(long)

Parameters:

permissions - The permissions to deny from the selected PermissionOverride

Returns:

RestAction
Update RestAction from #update()

Throws:

PermissionException - If the currently logged in account does not have the Permission MANAGE_PERMISSIONS

See Also:

PermOverrideManagerUpdatable.deny(long), PermOverrideManagerUpdatable.update()

deny

public RestAction<java.lang.Void> deny(Permission... permissions)

Denies the provided Permissions from the selected PermissionOverridie.
Wraps PermOverrideManagerUpdatable.deny(long)

Parameters:

permissions - The permissions to deny from the selected PermissionOverride

Returns:

RestAction
Update RestAction from #update()

Throws:

PermissionException - If the currently logged in account does not have the Permission MANAGE_PERMISSIONS

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

See Also:

PermOverrideManagerUpdatable.deny(Permission...), PermOverrideManagerUpdatable.update()

deny

public RestAction<java.lang.Void> deny(java.util.Collection<Permission> permissions)

Denies the provided Permissions from the selected PermissionOverridie.
Wraps PermOverrideManagerUpdatable.deny(long)

Parameters:

permissions - The permissions to deny from the selected PermissionOverride

Returns:

RestAction
Update RestAction from #update()

Throws:

PermissionException - If the currently logged in account does not have the Permission MANAGE_PERMISSIONS

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

See Also:

PermOverrideManagerUpdatable.deny(Collection), PermOverrideManagerUpdatable.update()

clear

public RestAction<java.lang.Void> clear(long permissions)

Clears the provided Permissions bits from the selected PermissionOverridie.
Wraps PermOverrideManagerUpdatable.clear(long)
This will cause the provided Permissions to be inherited

Parameters:

permissions - The permissions to clear from the selected PermissionOverride

Returns:

RestAction
Update RestAction from #update()

Throws:

PermissionException - If the currently logged in account does not have the Permission MANAGE_PERMISSIONS

See Also:

PermOverrideManagerUpdatable.clear(long), PermOverrideManagerUpdatable.update()

clear

public RestAction<java.lang.Void> clear(Permission... permissions)

Clears the provided Permissions bits from the selected PermissionOverridie.
Wraps PermOverrideManagerUpdatable.clear(long)
This will cause the provided Permissions to be inherited

Parameters:

permissions - The permissions to clear from the selected PermissionOverride

Returns:

RestAction
Update RestAction from #update()

Throws:

PermissionException - If the currently logged in account does not have the Permission MANAGE_PERMISSIONS

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

See Also:

PermOverrideManagerUpdatable.clear(Permission...), PermOverrideManagerUpdatable.update()

clear

public RestAction<java.lang.Void> clear(java.util.Collection<Permission> permissions)

Clears the provided Permissions bits from the selected PermissionOverridie.
Wraps PermOverrideManagerUpdatable.clear(long)
This will cause the provided Permissions to be inherited

Parameters:

permissions - The permissions to clear from the selected PermissionOverride

Returns:

RestAction
Update RestAction from #update()

Throws:

PermissionException - If the currently logged in account does not have the Permission MANAGE_PERMISSIONS

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

See Also:

PermOverrideManagerUpdatable.clear(Collection), PermOverrideManagerUpdatable.update()