discord4j.core.spec

Class RoleCreateSpec

java.lang.Object

discord4j.core.spec.RoleCreateSpec

All Implemented Interfaces:

AuditSpec<discord4j.discordjson.json.RoleCreateRequest>, Spec<discord4j.discordjson.json.RoleCreateRequest>

public class RoleCreateSpec
extends Object
implements AuditSpec<discord4j.discordjson.json.RoleCreateRequest>

Spec used to create a new guild Role entity.

See Also:

Create Guild Role

Constructor Summary

Constructors

Constructor and Description
RoleCreateSpec()

Method Summary

Modifier and Type	Method and Description
discord4j.discordjson.json.RoleCreateRequest	asRequest()
String	getReason() Returns the current audit log reason set on the spec.
RoleCreateSpec	setColor(Color color) Sets the color of the created Role.
RoleCreateSpec	setHoist(boolean hoist) Sets whether the created Role should be displayed separately in the sidebar.
RoleCreateSpec	setMentionable(boolean mentionable) Sets whether the created Role should be mentionable.
RoleCreateSpec	setName(String name) Sets the name of the created Role.
RoleCreateSpec	setPermissions(PermissionSet permissions) Sets the enabled/disabled permissions, in the form of a PermissionSet for the created Role.
RoleCreateSpec	setReason(String reason) Sets the reason to show in the audit logs when the spec is built.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleCreateSpec

public RoleCreateSpec()

Method Detail

setName

public RoleCreateSpec setName(String name)

Sets the name of the created Role.

Parameters:

name - The role name.

Returns:

This spec.

setPermissions

public RoleCreateSpec setPermissions(PermissionSet permissions)

Sets the enabled/disabled permissions, in the form of a PermissionSet for the created Role.

Parameters:

permissions - The role permissions.

Returns:

This spec.

setColor

public RoleCreateSpec setColor(Color color)

Sets the color of the created Role.

Parameters:

color - The role color.

Returns:

This spec.

setHoist

public RoleCreateSpec setHoist(boolean hoist)

Sets whether the created Role should be displayed separately in the sidebar.

Parameters:

hoist - The role hoisted property.

Returns:

This spec.

setMentionable

public RoleCreateSpec setMentionable(boolean mentionable)

Sets whether the created Role should be mentionable.

Parameters:

mentionable - The role mentionable property.

Returns:

This spec.

setReason

public RoleCreateSpec setReason(@Nullable
                                String reason)

Description copied from interface: AuditSpec

Sets the reason to show in the audit logs when the spec is built.

Specified by:

setReason in interface AuditSpec<discord4j.discordjson.json.RoleCreateRequest>

Parameters:

reason - The audit log reason.

Returns:

This spec.

getReason

@Nullable
public String getReason()

Description copied from interface: AuditSpec

Returns the current audit log reason set on the spec.

Specified by:

getReason in interface AuditSpec<discord4j.discordjson.json.RoleCreateRequest>

Returns:

The current audit log reason.

asRequest

public discord4j.discordjson.json.RoleCreateRequest asRequest()

Specified by:

asRequest in interface Spec<discord4j.discordjson.json.RoleCreateRequest>