Package net.dv8tion.jda.internal.managers

Class RoleManagerImpl

java.lang.Object

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

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

net.dv8tion.jda.internal.managers.ManagerBase<RoleManager>

net.dv8tion.jda.internal.managers.RoleManagerImpl

All Implemented Interfaces:

Manager<RoleManager>, RoleManager, RestAction<Void>, AuditableRestAction<Void>

public class RoleManagerImpl
extends ManagerBase<RoleManager>
implements RoleManager

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

Fields inherited from interface net.dv8tion.jda.api.managers.RoleManager

COLOR, HOIST, ICON, MENTIONABLE, NAME, PERMISSION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Role	getRole()	The target Role for this manager
RoleManagerImpl	givePermissions(Collection<Permission> perms)	Adds the specified Permissions to the selected Role.
RoleManagerImpl	reset()	Resets all fields for this Manager
RoleManagerImpl	reset(long fields)	Resets the fields specified by the provided bit-flag pattern.
RoleManagerImpl	reset(long... fields)	Resets the fields specified by the provided bit-flag patterns.
RoleManagerImpl	revokePermissions(Collection<Permission> perms)	Revokes the specified Permissions from the selected Role.
RoleManagerImpl	setColor(int rgb)	Sets the rgb color of the selected Role.
RoleManagerImpl	setHoisted(boolean hoisted)	Sets the hoist state of the selected Role.
RoleManagerImpl	setIcon(String emoji)	Sets the Unicode Emoji of this Role instead of a custom image.
RoleManagerImpl	setIcon(Icon icon)	Sets the Icon of this Role.
RoleManagerImpl	setMentionable(boolean mentionable)	Sets the mentionable state of the selected Role.
RoleManagerImpl	setName(String name)	Sets the name of the selected Role.
RoleManagerImpl	setPermissions(long perms)	Sets the Permissions of the selected Role.

Methods inherited from class net.dv8tion.jda.internal.managers.ManagerBase

complete, deadline, isPermissionChecksEnabled, queue, setCheck, setPermissionChecksEnabled, timeout

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

reason

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

getCheck, getDefaultFailure, getDefaultSuccess, getDefaultTimeout, getJDA, handleResponse, isPassContext, priority, 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.managers.Manager

deadline, setCheck, timeout

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

Methods inherited from interface net.dv8tion.jda.api.managers.RoleManager

getGuild, givePermissions, revokePermissions, setColor, setIcon, setPermissions, setPermissions

Constructor Details

RoleManagerImpl

public RoleManagerImpl(Role role)

Creates a new RoleManager instance

Parameters:

role - Role that should be modified

Method Details

getRole

@Nonnull
public Role getRole()

Description copied from interface: RoleManager

The target Role for this manager

Specified by:

getRole in interface RoleManager

Returns:

The target Role

reset

@Nonnull
@CheckReturnValue
public RoleManagerImpl reset(long fields)

Description copied from interface: RoleManager

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:

• RoleManager.NAME
• RoleManager.COLOR
• RoleManager.PERMISSION
• RoleManager.HOIST
• RoleManager.MENTIONABLE
• RoleManager.ICON

Specified by:

reset in interface Manager<RoleManager>

Specified by:

reset in interface RoleManager

Overrides:

reset in class ManagerBase<RoleManager>

Parameters:

fields - Integer value containing the flags to reset.

Returns:

RoleManager for chaining convenience

reset

@Nonnull
@CheckReturnValue
public RoleManagerImpl reset(long... fields)

Description copied from interface: RoleManager

Resets the fields specified by the provided bit-flag patterns.
Example: manager.reset(RoleManager.COLOR, RoleManager.NAME);

Flag Constants:

• RoleManager.NAME
• RoleManager.COLOR
• RoleManager.PERMISSION
• RoleManager.HOIST
• RoleManager.MENTIONABLE
• RoleManager.ICON

Specified by:

reset in interface Manager<RoleManager>

Specified by:

reset in interface RoleManager

Overrides:

reset in class ManagerBase<RoleManager>

Parameters:

fields - Integer values containing the flags to reset.

Returns:

RoleManager for chaining convenience

reset

@Nonnull
@CheckReturnValue
public RoleManagerImpl reset()

Description copied from interface: Manager

Resets all fields for this Manager

Specified by:

reset in interface Manager<RoleManager>

Overrides:

reset in class ManagerBase<RoleManager>

Returns:

The current Manager with all settings reset to default

setName

@Nonnull
@CheckReturnValue
public RoleManagerImpl setName(@Nonnull
 String name)

Description copied from interface: RoleManager

Sets the name of the selected Role.

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

Specified by:

setName in interface RoleManager

Parameters:

name - The new name for the selected Role

Returns:

RoleManager for chaining convenience

setPermissions

@Nonnull
@CheckReturnValue
public RoleManagerImpl setPermissions(long perms)

Description copied from interface: RoleManager

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!

Specified by:

setPermissions in interface RoleManager

Parameters:

perms - The new raw permission value for the selected Role

Returns:

RoleManager for chaining convenience

See Also:

• RoleManager.setPermissions(Collection)
• RoleManager.setPermissions(Permission...)

setColor

@Nonnull
@CheckReturnValue
public RoleManagerImpl setColor(int rgb)

Description copied from interface: RoleManager

Sets the rgb color of the selected Role.

Specified by:

setColor in interface RoleManager

Parameters:

rgb - The new color for the selected Role

Returns:

RoleManager for chaining convenience

See Also:

• Role.DEFAULT_COLOR_RAW

setHoisted

@Nonnull
@CheckReturnValue
public RoleManagerImpl setHoisted(boolean hoisted)

Description copied from interface: RoleManager

Sets the hoist state of the selected Role.

Specified by:

setHoisted in interface RoleManager

Parameters:

hoisted - Whether the selected Role should be hoisted

Returns:

RoleManager for chaining convenience

setMentionable

@Nonnull
@CheckReturnValue
public RoleManagerImpl setMentionable(boolean mentionable)

Description copied from interface: RoleManager

Sets the mentionable state of the selected Role.

Specified by:

setMentionable in interface RoleManager

Parameters:

mentionable - Whether the selected Role should be mentionable

Returns:

RoleManager for chaining convenience

setIcon

@Nonnull
@CheckReturnValue
public RoleManagerImpl setIcon(Icon icon)

Description copied from interface: RoleManager

Sets the Icon of this Role.

Specified by:

setIcon in interface RoleManager

Parameters:

icon - The new icon for this Role or null to reset

Returns:

RoleManager for chaining convenience

setIcon

@Nonnull
@CheckReturnValue
public RoleManagerImpl setIcon(String emoji)

Description copied from interface: RoleManager

Sets the Unicode Emoji of this Role instead of a custom image.

Specified by:

setIcon in interface RoleManager

Parameters:

emoji - The new Unicode Emoji for this Role or null to reset

Returns:

RoleManager for chaining convenience

givePermissions

@Nonnull
@CheckReturnValue
public RoleManagerImpl givePermissions(@Nonnull
 Collection<Permission> perms)

Description copied from interface: RoleManager

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!

Specified by:

givePermissions in interface RoleManager

Parameters:

perms - The permission to give to the selected Role

Returns:

RoleManager for chaining convenience

See Also:

• RoleManager.setPermissions(Collection)
• RoleManager.setPermissions(Permission...)
• EnumSet
• Permission.getRaw(Collection)

revokePermissions

@Nonnull
@CheckReturnValue
public RoleManagerImpl revokePermissions(@Nonnull
 Collection<Permission> perms)

Description copied from interface: RoleManager

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!

Specified by:

revokePermissions in interface RoleManager

Parameters:

perms - The permission to give to the selected Role

Returns:

RoleManager for chaining convenience

See Also:

• RoleManager.setPermissions(Collection)
• RoleManager.setPermissions(Permission...)
• EnumSet
• Permission.getRaw(Collection)