discord4j.core.spec

Class NewsChannelCreateSpec

java.lang.Object

discord4j.core.spec.NewsChannelCreateSpec

All Implemented Interfaces:

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

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

Spec used to create guild NewsChannel entities.

See Also:

Create Guild Channel

Constructor Summary

Constructors

Constructor and Description
NewsChannelCreateSpec()

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

NewsChannelCreateSpec

public NewsChannelCreateSpec()

Method Detail

setName

public NewsChannelCreateSpec setName(String name)

Sets the name of the created NewsChannel.

Parameters:

name - The channel name.

Returns:

This spec.

setTopic

public NewsChannelCreateSpec setTopic(String topic)

Sets the created NewsChannel topic.

Parameters:

topic - The channel topic.

Returns:

This spec.

setPosition

public NewsChannelCreateSpec setPosition(int position)

Sets the sorting position of the created NewsChannel.

Parameters:

position - The channel position.

Returns:

This spec.

setPermissionOverwrites

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

Sets the created NewsChannel permission overwrites.

Parameters:

permissionOverwrites - The set of PermissionOverwrite objects.

Returns:

This spec.

setParentId

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