discord4j.core.spec

Class NewsChannelEditSpec

java.lang.Object

discord4j.core.spec.NewsChannelEditSpec

All Implemented Interfaces:

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

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

Spec used to modify a guild NewsChannel settings. G

See Also:

Modify Channel

Constructor Summary

Constructors

Constructor and Description
NewsChannelEditSpec()

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.
NewsChannelEditSpec	setName(String name) Sets the name of the modified NewsChannel.
NewsChannelEditSpec	setNsfw(boolean nsfw) Sets whether the modified NewsChannel should be NSFW (not safe for work).
NewsChannelEditSpec	setParentId(Snowflake parentId) Sets the identifier of the parent category of the modified NewsChannel.
NewsChannelEditSpec	setPermissionOverwrites(Set<? extends PermissionOverwrite> permissionOverwrites) Sets the modified NewsChannel permission overwrites.
NewsChannelEditSpec	setPosition(int position) Sets the position of the modified NewsChannel.
NewsChannelEditSpec	setReason(String reason) Sets the reason to show in the audit logs when the spec is built.
NewsChannelEditSpec	setTopic(String topic) Sets the topic of the modified NewsChannel.

Methods inherited from class java.lang.Object

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

Constructor Detail

NewsChannelEditSpec

public NewsChannelEditSpec()

Method Detail

setName

public NewsChannelEditSpec setName(String name)

Sets the name of the modified NewsChannel.

Parameters:

name - The channel name.

Returns:

This spec.

setPosition

public NewsChannelEditSpec setPosition(int position)

Sets the position of the modified NewsChannel.

Parameters:

position - The channel position.

Returns:

This spec.

setTopic

public NewsChannelEditSpec setTopic(String topic)

Sets the topic of the modified NewsChannel.

Parameters:

topic - The channel topic.

Returns:

This spec.

setNsfw

public NewsChannelEditSpec setNsfw(boolean nsfw)

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

Parameters:

nsfw - The channel nsfw property.

Returns:

This spec.

setPermissionOverwrites

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

Sets the modified NewsChannel permission overwrites.

Parameters:

permissionOverwrites - The set of PermissionOverwrite objects.

Returns:

This spec.

setParentId

public NewsChannelEditSpec setParentId(@Nullable
                                       Snowflake parentId)

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

Parameters:

parentId - The parent category identifier.

Returns:

This spec.

setReason

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