Package net.dv8tion.jda.internal.entities.mixin

Interface RoleMixin<T extends RoleMixin<T>>

All Superinterfaces:

Comparable<Role>, Formattable, IDetachableEntity, IDetachableEntityMixin, IMentionable, IPermissionHolder, ISnowflake, Role

All Known Implementing Classes:

DetachedRoleImpl, RoleImpl

public interface RoleMixin<T extends RoleMixin<T>>
extends Role, IDetachableEntityMixin

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.entities.Role

Role.RoleTags

Field Summary

Fields inherited from interface net.dv8tion.jda.api.entities.Role

DEFAULT_COLOR_RAW

Method Summary

Modifier and Type	Method	Description
default int	compareTo(Role r)
default RoleAction	createCopy(Guild guild)	Creates a new Role in the specified Guild with the same settings as the given Role.
T	setColor(int color)
T	setHoisted(boolean hoisted)
T	setIcon(RoleIcon icon)
T	setManaged(boolean managed)
T	setMentionable(boolean mentionable)
T	setName(String name)
T	setRawPermissions(long rawPermissions)
T	setRawPosition(int rawPosition)
T	setTags(DataObject tags)

Methods inherited from interface net.dv8tion.jda.api.entities.detached.IDetachableEntity

isDetached

Methods inherited from interface net.dv8tion.jda.internal.entities.detached.mixin.IDetachableEntityMixin

checkAttached, detachedException, detachedRequiresChannelException

Methods inherited from interface net.dv8tion.jda.api.entities.IMentionable

formatTo, getAsMention

Methods inherited from interface net.dv8tion.jda.api.entities.IPermissionHolder

canSync, canSync, getPermissions, getPermissions, getPermissionsExplicit, getPermissionsExplicit, hasAccess, hasPermission, hasPermission, hasPermission, hasPermission

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getIdLong, getTimeCreated

Methods inherited from interface net.dv8tion.jda.api.entities.Role

canInteract, createCopy, delete, getColor, getColorRaw, getGuild, getIcon, getJDA, getManager, getName, getPermissionsRaw, getPosition, getPositionRaw, getTags, isHoisted, isManaged, isMentionable, isPublicRole

Method Details

createCopy

@Nonnull
default RoleAction createCopy(@Nonnull
 Guild guild)

Description copied from interface: Role

Creates a new Role in the specified Guild with the same settings as the given Role.
The position of the specified Role does not matter in this case!
If this Role has an Icon set, only its emoji can be copied over.

It will be placed at the bottom (just over the Public Role) to avoid permission hierarchy conflicts.
For this to be successful, the logged in account has to have the MANAGE_ROLES Permission and all Permissions the given Role has.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The role could not be created due to a permission discrepancy
• MAX_ROLES_PER_GUILD
  There are too many roles in this Guild

Specified by:

createCopy in interface Role

Parameters:

guild - The Role that should be copied

Returns:

RoleAction
RoleAction with already copied values from the specified Role

compareTo

default int compareTo(@Nonnull
 Role r)

Specified by:

compareTo in interface Comparable<T extends RoleMixin<T>>

setName

T setName(String name)

setColor

T setColor(int color)

setManaged

T setManaged(boolean managed)

setHoisted

T setHoisted(boolean hoisted)

setMentionable

T setMentionable(boolean mentionable)

setRawPermissions

T setRawPermissions(long rawPermissions)

setRawPosition

T setRawPosition(int rawPosition)

setTags

T setTags(DataObject tags)

setIcon

T setIcon(RoleIcon icon)