discord4j.core.spec

Class TextChannelEditSpec

java.lang.Object

discord4j.core.spec.TextChannelEditSpec

All Implemented Interfaces:

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

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

Spec used to modify a guild TextChannel settings.

See Also:

Modify Channel

Constructor Summary

Constructors

Constructor and Description
TextChannelEditSpec()

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.
TextChannelEditSpec	setName(String name) Sets the name of the modified TextChannel.
TextChannelEditSpec	setNsfw(boolean nsfw) Sets whether the modified TextChannel should be NSFW (not safe for work).
TextChannelEditSpec	setParentId(Snowflake parentId) Sets the identifier of the parent category of the modified TextChannel.
TextChannelEditSpec	setPermissionOverwrites(Set<? extends PermissionOverwrite> permissionOverwrites) Sets the modified TextChannel permission overwrites.
TextChannelEditSpec	setPosition(int position) Sets the position of the modified TextChannel.
TextChannelEditSpec	setRateLimitPerUser(int rateLimitPerUser) Sets the amount of seconds a user has to wait before sending another message to the modified TextChannel, from 0 to 21600 seconds.
TextChannelEditSpec	setReason(String reason) Sets the reason to show in the audit logs when the spec is built.
TextChannelEditSpec	setTopic(String topic) Sets the topic of the modified TextChannel.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextChannelEditSpec

public TextChannelEditSpec()

Method Detail

setName

public TextChannelEditSpec setName(String name)

Sets the name of the modified TextChannel.

Parameters:

name - The channel name.

Returns:

This spec.

setPosition

public TextChannelEditSpec setPosition(int position)

Sets the position of the modified TextChannel.

Parameters:

position - The channel position.

Returns:

This spec.

setTopic

public TextChannelEditSpec setTopic(String topic)

Sets the topic of the modified TextChannel.

Parameters:

topic - The channel topic.

Returns:

This spec.

setNsfw

public TextChannelEditSpec setNsfw(boolean nsfw)

Sets whether the modified TextChannel should be NSFW (not safe for work).

Parameters:

nsfw - The channel nsfw property.

Returns:

This spec.

setPermissionOverwrites

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

Sets the modified TextChannel permission overwrites.

Parameters:

permissionOverwrites - The set of PermissionOverwrite objects.

Returns:

This spec.

setParentId

public TextChannelEditSpec setParentId(@Nullable
                                       Snowflake parentId)

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

Parameters:

parentId - The parent category identifier.

Returns:

This spec.

setRateLimitPerUser

public TextChannelEditSpec setRateLimitPerUser(int rateLimitPerUser)

Sets the amount of seconds a user has to wait before sending another message to the modified TextChannel, from 0 to 21600 seconds. 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.

setReason

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