Package discord4j.core.spec.legacy

Class LegacyNewsChannelCreateSpec

java.lang.Object

discord4j.core.spec.legacy.LegacyNewsChannelCreateSpec

All Implemented Interfaces:

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

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

LegacySpec used to create guild NewsChannel entities.

See Also:

Create Guild Channel

Constructor Summary

Constructors

Constructor	Description
LegacyNewsChannelCreateSpec()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

LegacyNewsChannelCreateSpec

public LegacyNewsChannelCreateSpec()

Method Detail

setName

public LegacyNewsChannelCreateSpec setName(String name)

Sets the name of the created NewsChannel.

Parameters:

name - The channel name.

Returns:

This spec.

setTopic

public LegacyNewsChannelCreateSpec setTopic(String topic)

Sets the created NewsChannel topic.

Parameters:

topic - The channel topic.

Returns:

This spec.

setPosition

public LegacyNewsChannelCreateSpec setPosition(int position)

Sets the sorting position of the created NewsChannel.

Parameters:

position - The channel position.

Returns:

This spec.

setPermissionOverwrites

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

Sets the created NewsChannel permission overwrites.

Parameters:

permissionOverwrites - The set of PermissionOverwrite objects.

Returns:

This spec.

setParentId

public LegacyNewsChannelCreateSpec setParentId(@Nullable
                                               Snowflake parentId)

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

Parameters:

parentId - The parent category identifier.

Returns:

This spec.

setNsfw

public LegacyNewsChannelCreateSpec setNsfw(boolean nsfw)

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

Parameters:

nsfw - The channel nsfw property.

Returns:

This spec.

setReason

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