discord4j.core.spec

Class TextChannelCreateSpec

java.lang.Object

discord4j.core.spec.TextChannelCreateSpec

All Implemented Interfaces:

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

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

Spec used to create guild TextChannel entities.

See Also:

Create Guild Channel

Constructor Summary

Constructors

Constructor and Description
TextChannelCreateSpec()

Method Summary

Modifier and Type	Method and Description
discord4j.discordjson.json.ChannelCreateRequest	asRequest()
String	getReason() Returns the current audit log reason set on the spec.
TextChannelCreateSpec	setName(String name) Sets the name of the created TextChannel.
TextChannelCreateSpec	setNsfw(boolean nsfw) Sets whether the created TextChannel is NSFW (not safe for work).
TextChannelCreateSpec	setParentId(Snowflake parentId) Sets the identifier of the parent category of the created TextChannel.
TextChannelCreateSpec	setPermissionOverwrites(Set<? extends PermissionOverwrite> permissionOverwrites) Sets the created TextChannel permission overwrites.
TextChannelCreateSpec	setPosition(int position) Sets the sorting position of the created TextChannel.
TextChannelCreateSpec	setRateLimitPerUser(int rateLimitPerUser) Sets the amount of seconds a user has to wait before sending another message to the created TextChannel, from 0 to 120.
TextChannelCreateSpec	setReason(String reason) Sets the reason to show in the audit logs when the spec is built.
TextChannelCreateSpec	setTopic(String topic) Sets the created TextChannel topic.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextChannelCreateSpec

public TextChannelCreateSpec()

Method Detail

setName

public TextChannelCreateSpec setName(String name)

Sets the name of the created TextChannel.

Parameters:

name - The channel name.

Returns:

This spec.

setTopic

public TextChannelCreateSpec setTopic(@Nullable
                                      String topic)

Sets the created TextChannel topic.

Parameters:

topic - The channel topic.

Returns:

This spec.

setRateLimitPerUser

public TextChannelCreateSpec setRateLimitPerUser(int rateLimitPerUser)

Sets the amount of seconds a user has to wait before sending another message to the created TextChannel, from 0 to 120. Does not affect bots or users with Permission.MANAGE_MESSAGES or Permission.MANAGE_CHANNELS permissions.

Parameters:

rateLimitPerUser - The channel user rate limit, in seconds.

Returns:

This spec.

setPosition

public TextChannelCreateSpec setPosition(int position)

Sets the sorting position of the created TextChannel.

Parameters:

position - The channel position.

Returns:

This spec.

setPermissionOverwrites

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

Sets the created TextChannel permission overwrites.

Parameters:

permissionOverwrites - The set of PermissionOverwrite objects.

Returns:

This spec.

setParentId

public TextChannelCreateSpec setParentId(@Nullable
                                         Snowflake parentId)

Sets the identifier of the parent category of the created TextChannel.

Parameters:

parentId - The parent category identifier.

Returns:

This spec.

setNsfw

public TextChannelCreateSpec setNsfw(boolean nsfw)

Sets whether the created TextChannel is NSFW (not safe for work).

Parameters:

nsfw - The channel nsfw property.

Returns:

This spec.

setReason

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