discord4j.core.spec

Class StoreChannelEditSpec

java.lang.Object

discord4j.core.spec.StoreChannelEditSpec

All Implemented Interfaces:

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

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

Spec used to modify a guild StoreChannel settings.

See Also:

Modify Channel

Constructor Summary

Constructors

Constructor and Description
StoreChannelEditSpec()

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.
StoreChannelEditSpec	setName(String name) Sets the name for the StoreChannel.
StoreChannelEditSpec	setPermissionOverwrites(Set<? extends PermissionOverwrite> permissionOverwrites) Sets the permission overwrites for the StoreChannel.
StoreChannelEditSpec	setPosition(int position) Sets the position for the StoreChannel.
StoreChannelEditSpec	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

StoreChannelEditSpec

public StoreChannelEditSpec()

Method Detail

setName

public StoreChannelEditSpec setName(String name)

Sets the name for the StoreChannel.

Parameters:

name - The new name of the category.

Returns:

This spec.

setPosition

public StoreChannelEditSpec setPosition(int position)

Sets the position for the StoreChannel.

Parameters:

position - The raw position for the category.

Returns:

This spec.

setPermissionOverwrites

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

Sets the permission overwrites for the StoreChannel.

Parameters:

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

Returns:

This spec.

setReason

public StoreChannelEditSpec 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>