discord4j.core.spec

Class StoreChannelCreateSpec

java.lang.Object

discord4j.core.spec.StoreChannelCreateSpec

All Implemented Interfaces:

AuditSpec<ChannelCreateRequest>, Spec<ChannelCreateRequest>

public class StoreChannelCreateSpec
extends Object
implements AuditSpec<ChannelCreateRequest>

Spec used to create guild StoreChannel entities.

See Also:

Create Guild Channel

Constructor Summary

Constructors

Constructor and Description
StoreChannelCreateSpec()

Method Summary

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

StoreChannelCreateSpec

public StoreChannelCreateSpec()

Method Detail

setName

public StoreChannelCreateSpec setName(String name)

Sets the name for the created StoreChannel.

Parameters:

name - The name of the category.

Returns:

This spec.

setPosition

public StoreChannelCreateSpec setPosition(int position)

Sets the position for the created StoreChannel.

Parameters:

position - The raw position for the category.

Returns:

This spec.

setPermissionOverwrites

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

Sets the permission overwrites for the created StoreChannel.

Parameters:

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

Returns:

This spec.

setReason

public StoreChannelCreateSpec 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<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<ChannelCreateRequest>

Returns:

The current audit log reason.

asRequest

public ChannelCreateRequest asRequest()

Specified by:

asRequest in interface Spec<ChannelCreateRequest>