discord4j.core.object.entity

Class Role

java.lang.Object

discord4j.core.object.entity.Role

All Implemented Interfaces:

DiscordObject, Entity

public final class Role
extends Object
implements Entity

A Discord role.

See Also:

Role Object

Field Summary

Fields

Modifier and Type	Field and Description
static Color	DEFAULT_COLOR The default Color of a Role.

Constructor Summary

Constructors

Constructor and Description
Role(ServiceMediator serviceMediator, RoleBean data, long guildId) Constructs a Role with an associated ServiceMediator and Discord data.

Method Summary

Modifier and Type	Method and Description
Flux<Role>	changePosition(int position) Requests to change this role's position.
Mono<Void>	delete() Requests to delete this role.
Mono<Void>	delete(String reason) Requests to delete this role while optionally specifying the reason.
Mono<Role>	edit(Consumer<? super RoleEditSpec> spec) Requests to edit this role.
boolean	equals(Object obj)
DiscordClient	getClient() Gets the DiscordClient associated to this object.
Color	getColor() Gets the color assigned to this role.
Mono<Guild>	getGuild() Requests to retireve the guild this role is associated to.
Snowflake	getGuildId() Gets the ID of the guild this role is associated to.
Snowflake	getId() Gets the Snowflake that uniquely identifies this entity.
String	getMention() Gets the raw mention.
String	getName() Gets the role name.
PermissionSet	getPermissions() Gets the permissions assigned to this role.
Mono<Integer>	getPosition()
int	getRawPosition()
int	hashCode()
boolean	isEveryone() Gets whether this role corresponds to the @everyone role.
boolean	isHoisted() Gets whether if this role is pinned in the user listing.
boolean	isManaged() Gets whether this role is managed by an integration.
boolean	isMentionable() Gets whether this role is mentionable.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_COLOR

public static final Color DEFAULT_COLOR

The default Color of a Role.

Constructor Detail

Role

public Role(ServiceMediator serviceMediator,
            RoleBean data,
            long guildId)

Constructs a Role with an associated ServiceMediator and Discord data.

Parameters:

serviceMediator - The ServiceMediator associated to this object, must be non-null.

data - The raw data as represented by Discord, must be non-null.

guildId - The ID of the guild this role is associated to.

Method Detail

getClient

public DiscordClient getClient()

Description copied from interface: DiscordObject

Gets the DiscordClient associated to this object.

Specified by:

getClient in interface DiscordObject

Returns:

The DiscordClient associated to this object.

getRawPosition

public int getRawPosition()

getPosition

public Mono<Integer> getPosition()

getName

public String getName()

Gets the role name.

Returns:

The role name.

getColor

public Color getColor()

Gets the color assigned to this role.

Returns:

The color assigned to this role.

isHoisted

public boolean isHoisted()

Gets whether if this role is pinned in the user listing.

Returns:

true if this role is pinned in the user listing, false otherwise.

getPermissions

public PermissionSet getPermissions()

Gets the permissions assigned to this role.

Returns:

The permissions assigned to this role.

isManaged

public boolean isManaged()

Gets whether this role is managed by an integration.

Returns:

true if this role is managed by an integration, false otherwise.

isMentionable

public boolean isMentionable()

Gets whether this role is mentionable.

Returns:

true if this role is mentionable, false otherwise.

isEveryone

public boolean isEveryone()

Gets whether this role corresponds to the @everyone role.

Returns:

true if this role represents the @everyone role, false otherwise.

getGuildId

public Snowflake getGuildId()

Gets the ID of the guild this role is associated to.

Returns:

The ID of the guild this role is associated to.

getGuild

public Mono<Guild> getGuild()

Requests to retireve the guild this role is associated to.

Returns:

A Mono where, upon successful completion, emits the guild this role is associated to. If an error is received, it is emitted through the Mono.

getMention

public String getMention()

Gets the raw mention. This is the format utilized to directly mention another role (assuming the role exists in context of the mention).

Returns:

The raw mention.

getId

public Snowflake getId()

Description copied from interface: Entity

Gets the Snowflake that uniquely identifies this entity.

Specified by:

getId in interface Entity

Returns:

The Snowflake that uniquely identifies this entity.

edit

public Mono<Role> edit(Consumer<? super RoleEditSpec> spec)

Requests to edit this role.

Parameters:

spec - A Consumer that provides a "blank" RoleEditSpec to be operated on.

Returns:

A Mono where, upon successful completion, emits the edited Role. If an error is received, it is emitted through the Mono.

delete

public Mono<Void> delete()

Requests to delete this role.

Returns:

A Mono where, upon successful completion, emits nothing; indicating the role has been deleted. If an error is received, it is emitted through the Mono.

delete

public Mono<Void> delete(@Nullable
                         String reason)

Requests to delete this role while optionally specifying the reason.

Parameters:

reason - The reason, if present.

Returns:

A Mono where, upon successful completion, emits nothing; indicating the role has been deleted. If an error is received, it is emitted through the Mono.

changePosition

public Flux<Role> changePosition(int position)

Requests to change this role's position.

Parameters:

position - The position to change for this role.

Returns:

A Flux that continually emits all the roles associated to this role's guild. If an error is received, it is emitted through the Flux.

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object