discord4j.core.spec

Class GuildEmojiCreateSpec

java.lang.Object

discord4j.core.spec.GuildEmojiCreateSpec

All Implemented Interfaces:

AuditSpec<GuildEmojiCreateRequest>, Spec<GuildEmojiCreateRequest>

public class GuildEmojiCreateSpec
extends Object
implements AuditSpec<GuildEmojiCreateRequest>

Spec used to create GuildEmoji objects. Emojis and animated emojis have a maximum file size of 256kb.

See Also:

Constructor Summary

Constructors

Constructor and Description
GuildEmojiCreateSpec()

Method Summary

Modifier and Type	Method and Description
GuildEmojiCreateSpec	addRole(Snowflake roleId) Adds a role for which the created GuildEmoji will be whitelisted.
GuildEmojiCreateRequest	asRequest()
String	getReason() Returns the current audit log reason set on the spec.
GuildEmojiCreateSpec	setImage(Image image) Sets the image for the created GuildEmoji.
GuildEmojiCreateSpec	setName(String name) Sets the name for the created GuildEmoji.
GuildEmojiCreateSpec	setReason(String reason) Sets the reason to show in the audit logs when the spec is built.

Methods inherited from class java.lang.Object

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

Constructor Detail

GuildEmojiCreateSpec

public GuildEmojiCreateSpec()

Method Detail

setName

public GuildEmojiCreateSpec setName(String name)

Sets the name for the created GuildEmoji.

Parameters:

name - The name for the emoji.

Returns:

This spec.

setImage

public GuildEmojiCreateSpec setImage(Image image)

Sets the image for the created GuildEmoji.

Parameters:

image - The image used for the emoji.

Returns:

This spec.

addRole

public GuildEmojiCreateSpec addRole(Snowflake roleId)

Adds a role for which the created GuildEmoji will be whitelisted.

Parameters:

roleId - The role identifier.

Returns:

This spec.

setReason

public GuildEmojiCreateSpec 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<GuildEmojiCreateRequest>

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<GuildEmojiCreateRequest>

Returns:

The current audit log reason.

asRequest

public GuildEmojiCreateRequest asRequest()

Specified by:

asRequest in interface Spec<GuildEmojiCreateRequest>