Package discord4j.core.spec

Class CategoryCreateSpec

java.lang.Object

discord4j.core.spec.CategoryCreateSpec

All Implemented Interfaces:

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

public class CategoryCreateSpec
extends Object
implements AuditSpec<discord4j.discordjson.json.ChannelCreateRequest>

A spec used to configure and create a Category.

Constructor Summary

Constructors

Constructor	Description
CategoryCreateSpec()

Method Summary

Modifier and Type	Method	Description
discord4j.discordjson.json.ChannelCreateRequest	asRequest()
String	getReason()	Returns the current audit log reason set on the spec.
CategoryCreateSpec	setName(String name)	Sets the name for the created Category.
CategoryCreateSpec	setPermissionOverwrites(Set<? extends PermissionOverwrite> permissionOverwrites)	Sets the permission overwrites for the created Category.
CategoryCreateSpec	setPosition(int position)	Sets the position for the created Category.
CategoryCreateSpec	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

CategoryCreateSpec

public CategoryCreateSpec()

Method Detail

setName

public CategoryCreateSpec setName(String name)

Sets the name for the created Category.

Parameters:

name - The name of the category.

Returns:

This spec.

setPosition

public CategoryCreateSpec setPosition(int position)

Sets the position for the created Category.

Parameters:

position - The raw position for the category.

Returns:

This spec.

setPermissionOverwrites

public CategoryCreateSpec setPermissionOverwrites(Set<? extends PermissionOverwrite> permissionOverwrites)

Sets the permission overwrites for the created Category.

Parameters:

permissionOverwrites - The Set<PermissionOverwrite> which contains overwrites for the category.

Returns:

This spec.

setReason

public CategoryCreateSpec 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.ChannelCreateRequest>

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

Returns:

The current audit log reason.

asRequest

public discord4j.discordjson.json.ChannelCreateRequest asRequest()

Specified by:

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