Package net.dv8tion.jda.core.managers

Class RoleManager

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.RoleManager

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

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

Example

 manager.setName("Administrator")
        .setColor(null)
        .queue();
 manager.reset(RoleManager.PERMISSION | RoleManager.NAME)
        .setName("Traitor")
        .setColor(Color.RED)
        .queue();
 

See Also:

Role.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	COLOR	Used to reset the color field
static long	HOIST	Used to reset the hoisted field
static long	MENTIONABLE	Used to reset the mentionable field
static long	NAME	Used to reset the name field
static long	PERMISSION	Used to reset the permission field

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

DEFAULT_FAILURE, DEFAULT_SUCCESS, LOG

Constructor Summary

Constructors

Constructor	Description
RoleManager(Role role)	Creates a new RoleManager instance

Method Summary

Modifier and Type	Method	Description
Guild	getGuild()	The Guild this Manager's Role is in.
Role	getRole()	The target Role for this manager
RoleManager	givePermissions(java.util.Collection<Permission> perms)	Adds the specified Permissions to the selected Role.
RoleManager	givePermissions(Permission... perms)	Adds the specified Permissions to the selected Role.
RoleManager	reset()	Resets all fields for this manager.
RoleManager	reset(long fields)	Resets the fields specified by the provided bit-flag pattern.
RoleManager	reset(long... fields)	Resets the fields specified by the provided bit-flag patterns.
RoleManager	revokePermissions(java.util.Collection<Permission> perms)	Revokes the specified Permissions from the selected Role.
RoleManager	revokePermissions(Permission... perms)	Revokes the specified Permissions from the selected Role.
RoleManager	setColor(int rgb)	Sets the rgb color of the selected Role.
RoleManager	setColor(java.awt.Color color)	Sets the Color of the selected Role.
RoleManager	setHoisted(boolean hoisted)	Sets the hoist state of the selected Role.
RoleManager	setMentionable(boolean mentionable)	Sets the mentionable state of the selected Role.
RoleManager	setName(java.lang.String name)	Sets the name of the selected Role.
RoleManager	setPermissions(long perms)	Sets the Permissions of the selected Role.
RoleManager	setPermissions(java.util.Collection<Permission> permissions)	Sets the Permissions of the selected Role.
RoleManager	setPermissions(Permission... permissions)	Sets the Permissions of the selected Role.

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

NAME

public static final long NAME

Used to reset the name field

See Also:

Constant Field Values

COLOR

public static final long COLOR

Used to reset the color field

See Also:

Constant Field Values

PERMISSION

public static final long PERMISSION

Used to reset the permission field

See Also:

Constant Field Values

HOIST

public static final long HOIST

Used to reset the hoisted field

See Also:

Constant Field Values

MENTIONABLE

public static final long MENTIONABLE

Used to reset the mentionable field

See Also:

Constant Field Values

Constructor Detail

RoleManager

public RoleManager(Role role)

Creates a new RoleManager instance

Parameters:

role - Role that should be modified

Method Detail

getGuild

public Guild getGuild()

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

Returns:

The parent Guild

getRole

public Role getRole()

The target Role for this manager

Returns:

The target Role

reset

@CheckReturnValue
public RoleManager 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(RoleManager.COLOR | RoleManager.NAME);

Flag Constants:

• NAME
• COLOR
• PERMISSION
• HOIST
• MENTIONABLE

Overrides:

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

Parameters:

fields - Integer value containing the flags to reset.

Returns:

RoleManager for chaining convenience

reset

@CheckReturnValue
public RoleManager 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(RoleManager.COLOR, RoleManager.NAME);

Flag Constants:

• NAME
• COLOR
• PERMISSION
• HOIST
• MENTIONABLE

Overrides:

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

Parameters:

fields - Integer values containing the flags to reset.

Returns:

RoleManager for chaining convenience

reset

@CheckReturnValue
public RoleManager reset()

Resets all fields for this manager.

Overrides:

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

Returns:

RoleManager for chaining convenience

setName

@CheckReturnValue
public RoleManager setName(java.lang.String name)

Sets the name of the selected Role.

A role name must not be null nor less than 1 characters or more than 32 characters long!

Parameters:

name - The new name for the selected Role

Returns:

RoleManager for chaining convenience

Throws:

java.lang.IllegalArgumentException - If the provided name is null or not between 1-32 characters long

setPermissions

@CheckReturnValue
public RoleManager setPermissions(long perms)

Sets the Permissions of the selected Role.

Permissions may only include already present Permissions for the currently logged in account.
You are unable to give permissions you don't have!

Parameters:

perms - The new raw permission value for the selected Role

Returns:

RoleManager for chaining convenience

Throws:

InsufficientPermissionException - If the currently logged in account does not have permission to apply one of the specified permissions

See Also:

setPermissions(Collection), setPermissions(Permission...)

setPermissions

@CheckReturnValue
public RoleManager setPermissions(Permission... permissions)

Sets the Permissions of the selected Role.

Permissions may only include already present Permissions for the currently logged in account.
You are unable to give permissions you don't have!

Parameters:

permissions - The new permission for the selected Role

Returns:

RoleManager for chaining convenience

Throws:

InsufficientPermissionException - If the currently logged in account does not have permission to apply one of the specified permissions

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

See Also:

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

setPermissions

@CheckReturnValue
public RoleManager setPermissions(java.util.Collection<Permission> permissions)

Sets the Permissions of the selected Role.

Permissions may only include already present Permissions for the currently logged in account.
You are unable to give permissions you don't have!

Parameters:

permissions - The new permission for the selected Role

Returns:

RoleManager for chaining convenience

Throws:

InsufficientPermissionException - If the currently logged in account does not have permission to apply one of the specified permissions

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

See Also:

setPermissions(Permission...), setPermissions(long), EnumSet, Permission.getRaw(Collection)

setColor

@CheckReturnValue
public RoleManager setColor(java.awt.Color color)

Sets the Color of the selected Role.

Parameters:

color - The new color for the selected Role

Returns:

RoleManager for chaining convenience

setColor

@CheckReturnValue
public RoleManager setColor(int rgb)

Sets the rgb color of the selected Role.

Parameters:

rgb - The new color for the selected Role

Returns:

RoleManager for chaining convenience

See Also:

Role.DEFAULT_COLOR_RAW

setHoisted

@CheckReturnValue
public RoleManager setHoisted(boolean hoisted)

Sets the hoist state of the selected Role.

Parameters:

hoisted - Whether the selected Role should be hoisted

Returns:

RoleManager for chaining convenience

setMentionable

@CheckReturnValue
public RoleManager setMentionable(boolean mentionable)

Sets the mentionable state of the selected Role.

Parameters:

mentionable - Whether the selected Role should be mentionable

Returns:

RoleManager for chaining convenience

givePermissions

@CheckReturnValue
public RoleManager givePermissions(Permission... perms)

Adds the specified Permissions to the selected Role.

Permissions may only include already present Permissions for the currently logged in account.
You are unable to give permissions you don't have!

Parameters:

perms - The permission to give to the selected Role

Returns:

RoleManager for chaining convenience

Throws:

InsufficientPermissionException - If the currently logged in account does not have permission to apply one of the specified permissions

See Also:

setPermissions(Collection), setPermissions(Permission...), Permission.getRaw(Permission...)

givePermissions

@CheckReturnValue
public RoleManager givePermissions(java.util.Collection<Permission> perms)

Adds the specified Permissions to the selected Role.

Permissions may only include already present Permissions for the currently logged in account.
You are unable to give permissions you don't have!

Parameters:

perms - The permission to give to the selected Role

Returns:

RoleManager for chaining convenience

Throws:

InsufficientPermissionException - If the currently logged in account does not have permission to apply one of the specified permissions

See Also:

setPermissions(Collection), setPermissions(Permission...), EnumSet, Permission.getRaw(Collection)

revokePermissions

@CheckReturnValue
public RoleManager revokePermissions(Permission... perms)

Revokes the specified Permissions from the selected Role.

Permissions may only include already present Permissions for the currently logged in account.
You are unable to revoke permissions you don't have!

Parameters:

perms - The permission to give to the selected Role

Returns:

RoleManager for chaining convenience

Throws:

InsufficientPermissionException - If the currently logged in account does not have permission to revoke one of the specified permissions

See Also:

setPermissions(Collection), setPermissions(Permission...), Permission.getRaw(Permission...)

revokePermissions

@CheckReturnValue
public RoleManager revokePermissions(java.util.Collection<Permission> perms)

Revokes the specified Permissions from the selected Role.

Permissions may only include already present Permissions for the currently logged in account.
You are unable to revoke permissions you don't have!

Parameters:

perms - The permission to give to the selected Role

Returns:

RoleManager for chaining convenience

Throws:

InsufficientPermissionException - If the currently logged in account does not have permission to revoke one of the specified permissions

See Also:

setPermissions(Collection), setPermissions(Permission...), EnumSet, Permission.getRaw(Collection)