discord4j.core.spec

Class CategoryEditSpec

java.lang.Object

discord4j.core.spec.CategoryEditSpec

All Implemented Interfaces:

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

public class CategoryEditSpec
extends Object
implements AuditSpec<discord4j.discordjson.json.ChannelModifyRequest>

A spec used to edit an existing Category.

Constructor Summary

Constructors

Constructor and Description
CategoryEditSpec()

Method Summary

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

CategoryEditSpec

public CategoryEditSpec()

Method Detail

setName

public CategoryEditSpec setName(String name)

Sets the name for the Category.

Parameters:

name - The new name of the category.

Returns:

This spec.

setPosition

public CategoryEditSpec setPosition(int position)

Sets the position for the Category.

Parameters:

position - The raw position for the category.

Returns:

This spec.

setPermissionOverwrites

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

Sets the permission overwrites for the Category.

Parameters:

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

Returns:

This spec.

setReason

public CategoryEditSpec 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.ChannelModifyRequest>

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

Returns:

The current audit log reason.

asRequest

public discord4j.discordjson.json.ChannelModifyRequest asRequest()

Specified by:

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