Package discord4j.core.spec.legacy

Class LegacyTextChannelCreateSpec

java.lang.Object

discord4j.core.spec.legacy.LegacyTextChannelCreateSpec

All Implemented Interfaces:

LegacyAuditSpec<discord4j.discordjson.json.ChannelCreateRequest>, LegacySpec<discord4j.discordjson.json.ChannelCreateRequest>

public class LegacyTextChannelCreateSpec
extends Object
implements LegacyAuditSpec<discord4j.discordjson.json.ChannelCreateRequest>

LegacySpec used to create guild TextChannel entities.

See Also:

Create Guild Channel

Constructor Summary

Constructors

Constructor	Description
LegacyTextChannelCreateSpec()

Method Summary

Modifier and Type	Method	Description
discord4j.discordjson.json.ChannelCreateRequest	asRequest()
String	getReason()	Returns the current audit log reason set on the spec.
LegacyTextChannelCreateSpec	setName(String name)	Sets the name of the created TextChannel.
LegacyTextChannelCreateSpec	setNsfw(boolean nsfw)	Sets whether the created TextChannel is NSFW (not safe for work).
LegacyTextChannelCreateSpec	setParentId(Snowflake parentId)	Sets the identifier of the parent category of the created TextChannel.
LegacyTextChannelCreateSpec	setPermissionOverwrites(Set<? extends PermissionOverwrite> permissionOverwrites)	Sets the created TextChannel permission overwrites.
LegacyTextChannelCreateSpec	setPosition(int position)	Sets the sorting position of the created TextChannel.
LegacyTextChannelCreateSpec	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.
LegacyTextChannelCreateSpec	setReason(String reason)	Sets the reason to show in the audit logs when the spec is built.
LegacyTextChannelCreateSpec	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

LegacyTextChannelCreateSpec

public LegacyTextChannelCreateSpec()

Method Detail

setName

public LegacyTextChannelCreateSpec setName(String name)

Sets the name of the created TextChannel.

Parameters:

name - The channel name.

Returns:

This spec.

setTopic

public LegacyTextChannelCreateSpec setTopic(@Nullable
                                            String topic)

Sets the created TextChannel topic.

Parameters:

topic - The channel topic.

Returns:

This spec.

setRateLimitPerUser

public LegacyTextChannelCreateSpec 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 LegacyTextChannelCreateSpec setPosition(int position)

Sets the sorting position of the created TextChannel.

Parameters:

position - The channel position.

Returns:

This spec.

setPermissionOverwrites

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

Sets the created TextChannel permission overwrites.

Parameters:

permissionOverwrites - The set of PermissionOverwrite objects.

Returns:

This spec.

setParentId

public LegacyTextChannelCreateSpec 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 LegacyTextChannelCreateSpec 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 LegacyTextChannelCreateSpec setReason(@Nullable
                                             String reason)

Description copied from interface: LegacyAuditSpec

Sets the reason to show in the audit logs when the spec is built.

Specified by:

setReason in interface LegacyAuditSpec<discord4j.discordjson.json.ChannelCreateRequest>

Parameters:

reason - The audit log reason.

Returns:

This spec.

getReason

@Nullable
public String getReason()

Description copied from interface: LegacyAuditSpec

Returns the current audit log reason set on the spec.

Specified by:

getReason in interface LegacyAuditSpec<discord4j.discordjson.json.ChannelCreateRequest>

Returns:

The current audit log reason.

asRequest

public discord4j.discordjson.json.ChannelCreateRequest asRequest()

Specified by:

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