net.dv8tion.jda.client.managers

Class EmoteManagerUpdatable

java.lang.Object

net.dv8tion.jda.client.managers.EmoteManagerUpdatable

public class EmoteManagerUpdatable
extends java.lang.Object

An updatable manager that allows to modify emote settings like the name.

This manager allows to modify multiple fields at once by getting the EmoteField for specific properties and setting or resetting their values; followed by a call of update()!

The EmoteManager implementation simplifies this process by giving simple setters that return the update RestAction

Note: To update this manager the currently logged in account requires the Permission MANAGE_EMOTES and must be from AccountType.CLIENT

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	NAME_PATTERN

Constructor Summary

Constructors

Constructor and Description
EmoteManagerUpdatable(net.dv8tion.jda.core.entities.impl.EmoteImpl emote) Creates a new EmoteManagerUpdatable instance

Method Summary

Modifier and Type	Method and Description
Emote	getEmote() The target Emote that will be modified by this Manager
Guild	getGuild() The Guild this Manager's Emote is in.
JDA	getJDA() The JDA instance of this Manager
EmoteField<java.lang.String>	getNameField() An EmoteField for the name of the selected Emote.
EmoteField<java.util.Collection<Role>>	getRolesField() Deprecated. This setting is only available to whitelisted accounts and may be removed in successive builds.
void	reset() Resets all Fields for this manager instance by calling Field.reset() sequentially This is automatically called by update()
AuditableRestAction<java.lang.Void>	update() Creates a new RestAction instance that will apply all changes that have been made to this manager instance.

Methods inherited from class java.lang.Object

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

Field Detail

NAME_PATTERN

public static final java.util.regex.Pattern NAME_PATTERN

Constructor Detail

EmoteManagerUpdatable

public EmoteManagerUpdatable(net.dv8tion.jda.core.entities.impl.EmoteImpl emote)

Creates a new EmoteManagerUpdatable instance

Parameters:

emote - The target EmoteImpl to modify

Throws:

AccountTypeException - If the currently logged in account is not from AccountType.CLIENT

java.lang.IllegalStateException - If the specified Emote is fake or managed.

Method Detail

getJDA

public JDA getJDA()

The JDA instance of this Manager

Returns:

the corresponding JDA instance

getGuild

public Guild getGuild()

The Guild this Manager's Emote is in.
This is logically the same as calling getEmote().getGuild()

Returns:

The parent Guild

getEmote

public Emote getEmote()

The target Emote that will be modified by this Manager

Returns:

The target Emote

getNameField

public EmoteField<java.lang.String> getNameField()

An EmoteField for the name of the selected Emote.

To set the value use setValue(String) on the returned EmoteField instance.

An emote name must be an alphanumeric-with-underscores String between 2-32 chars in length!
Otherwise Field.setValue(...) will throw an IllegalArgumentException.
Example names: fmgSUP, tatDAB

Returns:

EmoteField - Type: String

getRolesField

@Deprecated
public EmoteField<java.util.Collection<Role>> getRolesField()

Deprecated. This setting is only available to whitelisted accounts and may be removed in successive builds.

An EmoteField for the restriction roles of the selected Emote.
If the roles are empty this Emote will be available to everyone.

To set the value use setValue(Collection) on the returned EmoteField instance.

An emote's restricted roles must not contain null!
Otherwise Field.setValue(...) will throw an IllegalArgumentException.

Returns:

EmoteField - Type: Collection

reset

public void reset()

Resets all Fields for this manager instance by calling Field.reset() sequentially
This is automatically called by update()

update

@CheckReturnValue
public AuditableRestAction<java.lang.Void> update()

Creates a new RestAction instance that will apply all changes that have been made to this manager instance.
If no changes have been made this will simply return EmptyRestAction.

Before applying new changes it is recommended to call reset() to reset previous changes.
This is automatically called if this method returns successfully.

Possible ErrorResponses for this update include the following:

• UNKNOWN_EMOJI
  If the target Emote was deleted before finishing the task
• MISSING_ACCESS
  If the currently logged in account was removed from the Guild before finishing the task
• MISSING_PERMISSIONS
  If the currently logged in account loses the MANAGE_EMOTES Permission before finishing the task

Returns:

AuditableRestAction
Applies all changes that have been made in a single api-call.

Throws:

InsufficientPermissionException - If the currently logged in account does not have the Permission MANAGE_EMOTES in the underlying Guild.