Package discord4j.core.spec

Class GuildEmojiEditSpec

java.lang.Object

discord4j.core.spec.GuildEmojiEditSpec

All Implemented Interfaces:

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

public class GuildEmojiEditSpec
extends Object
implements AuditSpec<discord4j.discordjson.json.GuildEmojiModifyRequest>

Spec used to modify an existing GuildEmoji.

See Also:

Modify Guild Emoji

Constructor Summary

Constructors

Constructor	Description
GuildEmojiEditSpec()

Method Summary

Modifier and Type	Method	Description
discord4j.discordjson.json.GuildEmojiModifyRequest	asRequest()
String	getReason()	Returns the current audit log reason set on the spec.
GuildEmojiEditSpec	setName(String name)	Sets the name for the modified GuildEmoji.
GuildEmojiEditSpec	setReason(String reason)	Sets the reason to show in the audit logs when the spec is built.
GuildEmojiEditSpec	setRoles(Set<Snowflake> roles)	Sets the list of roles for which the modified GuildEmoji will be whitelisted.

Methods inherited from class java.lang.Object

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

Constructor Detail

GuildEmojiEditSpec

public GuildEmojiEditSpec()

Method Detail

setName

public GuildEmojiEditSpec setName(String name)

Sets the name for the modified GuildEmoji.

Parameters:

name - The name for the emoji.

Returns:

This spec.

setRoles

public GuildEmojiEditSpec setRoles(Set<Snowflake> roles)

Sets the list of roles for which the modified GuildEmoji will be whitelisted.

Parameters:

roles - The set of role identifiers.

Returns:

This spec.

setReason

public GuildEmojiEditSpec 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.GuildEmojiModifyRequest>

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.GuildEmojiModifyRequest>

Returns:

The current audit log reason.

asRequest

public discord4j.discordjson.json.GuildEmojiModifyRequest asRequest()

Specified by:

asRequest in interface Spec<discord4j.discordjson.json.GuildEmojiModifyRequest>